This version is the edition 2.5 of the GNU Emacs Lisp Reference Manual. It corresponds to Emacs Version 20.3 Published by the Free Software Foundation 59 Temple Place, Suite 330 Boston, MA 02111-1307 USA Copyright (C) 1990, 1991, 1992, 1993, 1994, 1995, 1996, 1998 Free Software Foundation, Inc. Permission is granted to make and distribute verbatim copies of this manual provided the copyright notice and this permission notice are preserved on all copies. Permission is granted to copy and distribute modified versions of this manual under the conditions for verbatim copying, provided that the entire resulting derived work is distributed under the terms of a permission notice identical to this one. Permission is granted to copy and distribute translations of this manual into another language, under the above conditions for modified versions, except that this permission notice may be stated in a translation approved by the Foundation. Permission is granted to copy and distribute modified versions of this manual under the conditions for verbatim copying, provided also that the section entitled "GNU General Public License" is included exactly as in the original, and provided that the entire resulting derived work is distributed under the terms of a permission notice identical to this one. Permission is granted to copy and distribute translations of this manual into another language, under the above conditions for modified versions, except that the section entitled "GNU General Public License" may be included in a translation approved by the Free Software Foundation instead of in the original English. This Info file contains edition 2.5 of the GNU Emacs Lisp Reference Manual, corresponding to GNU Emacs version 20.3. GNU GENERAL PUBLIC LICENSE ************************** Version 2, June 1991 Copyright (C) 1989, 1991 Free Software Foundation, Inc. 59 Temple Place, Suite 330, Boston, MA 02111, USA Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. Preamble ======== The licenses for most software are designed to take away your freedom to share and change it. By contrast, the GNU General Public License is intended to guarantee your freedom to share and change free software--to make sure the software is free for all its users. This General Public License applies to most of the Free Software Foundation's software and to any other program whose authors commit to using it. (Some other Free Software Foundation software is covered by the GNU Library General Public License instead.) You can apply it to your programs, too. When we speak of free software, we are referring to freedom, not price. Our General Public Licenses are designed to make sure that you have the freedom to distribute copies of free software (and charge for this service if you wish), that you receive source code or can get it if you want it, that you can change the software or use pieces of it in new free programs; and that you know you can do these things. To protect your rights, we need to make restrictions that forbid anyone to deny you these rights or to ask you to surrender the rights. These restrictions translate to certain responsibilities for you if you distribute copies of the software, or if you modify it. For example, if you distribute copies of such a program, whether gratis or for a fee, you must give the recipients all the rights that you have. You must make sure that they, too, receive or can get the source code. And you must show them these terms so they know their rights. We protect your rights with two steps: (1) copyright the software, and (2) offer you this license which gives you legal permission to copy, distribute and/or modify the software. Also, for each author's protection and ours, we want to make certain that everyone understands that there is no warranty for this free software. If the software is modified by someone else and passed on, we want its recipients to know that what they have is not the original, so that any problems introduced by others will not reflect on the original authors' reputations. Finally, any free program is threatened constantly by software patents. We wish to avoid the danger that redistributors of a free program will individually obtain patent licenses, in effect making the program proprietary. To prevent this, we have made it clear that any patent must be licensed for everyone's free use or not licensed at all. The precise terms and conditions for copying, distribution and modification follow. TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION 0. This License applies to any program or other work which contains a notice placed by the copyright holder saying it may be distributed under the terms of this General Public License. The "Program", below, refers to any such program or work, and a "work based on the Program" means either the Program or any derivative work under copyright law: that is to say, a work containing the Program or a portion of it, either verbatim or with modifications and/or translated into another language. (Hereinafter, translation is included without limitation in the term "modification".) Each licensee is addressed as "you". Activities other than copying, distribution and modification are not covered by this License; they are outside its scope. The act of running the Program is not restricted, and the output from the Program is covered only if its contents constitute a work based on the Program (independent of having been made by running the Program). Whether that is true depends on what the Program does. 1. You may copy and distribute verbatim copies of the Program's source code as you receive it, in any medium, provided that you conspicuously and appropriately publish on each copy an appropriate copyright notice and disclaimer of warranty; keep intact all the notices that refer to this License and to the absence of any warranty; and give any other recipients of the Program a copy of this License along with the Program. You may charge a fee for the physical act of transferring a copy, and you may at your option offer warranty protection in exchange for a fee. 2. You may modify your copy or copies of the Program or any portion of it, thus forming a work based on the Program, and copy and distribute such modifications or work under the terms of Section 1 above, provided that you also meet all of these conditions: a. You must cause the modified files to carry prominent notices stating that you changed the files and the date of any change. b. You must cause any work that you distribute or publish, that in whole or in part contains or is derived from the Program or any part thereof, to be licensed as a whole at no charge to all third parties under the terms of this License. c. If the modified program normally reads commands interactively when run, you must cause it, when started running for such interactive use in the most ordinary way, to print or display an announcement including an appropriate copyright notice and a notice that there is no warranty (or else, saying that you provide a warranty) and that users may redistribute the program under these conditions, and telling the user how to view a copy of this License. (Exception: if the Program itself is interactive but does not normally print such an announcement, your work based on the Program is not required to print an announcement.) These requirements apply to the modified work as a whole. If identifiable sections of that work are not derived from the Program, and can be reasonably considered independent and separate works in themselves, then this License, and its terms, do not apply to those sections when you distribute them as separate works. But when you distribute the same sections as part of a whole which is a work based on the Program, the distribution of the whole must be on the terms of this License, whose permissions for other licensees extend to the entire whole, and thus to each and every part regardless of who wrote it. Thus, it is not the intent of this section to claim rights or contest your rights to work written entirely by you; rather, the intent is to exercise the right to control the distribution of derivative or collective works based on the Program. In addition, mere aggregation of another work not based on the Program with the Program (or with a work based on the Program) on a volume of a storage or distribution medium does not bring the other work under the scope of this License. 3. You may copy and distribute the Program (or a work based on it, under Section 2) in object code or executable form under the terms of Sections 1 and 2 above provided that you also do one of the following: a. Accompany it with the complete corresponding machine-readable source code, which must be distributed under the terms of Sections 1 and 2 above on a medium customarily used for software interchange; or, b. Accompany it with a written offer, valid for at least three years, to give any third party, for a charge no more than your cost of physically performing source distribution, a complete machine-readable copy of the corresponding source code, to be distributed under the terms of Sections 1 and 2 above on a medium customarily used for software interchange; or, c. Accompany it with the information you received as to the offer to distribute corresponding source code. (This alternative is allowed only for noncommercial distribution and only if you received the program in object code or executable form with such an offer, in accord with Subsection b above.) The source code for a work means the preferred form of the work for making modifications to it. For an executable work, complete source code means all the source code for all modules it contains, plus any associated interface definition files, plus the scripts used to control compilation and installation of the executable. However, as a special exception, the source code distributed need not include anything that is normally distributed (in either source or binary form) with the major components (compiler, kernel, and so on) of the operating system on which the executable runs, unless that component itself accompanies the executable. If distribution of executable or object code is made by offering access to copy from a designated place, then offering equivalent access to copy the source code from the same place counts as distribution of the source code, even though third parties are not compelled to copy the source along with the object code. 4. You may not copy, modify, sublicense, or distribute the Program except as expressly provided under this License. Any attempt otherwise to copy, modify, sublicense or distribute the Program is void, and will automatically terminate your rights under this License. However, parties who have received copies, or rights, from you under this License will not have their licenses terminated so long as such parties remain in full compliance. 5. You are not required to accept this License, since you have not signed it. However, nothing else grants you permission to modify or distribute the Program or its derivative works. These actions are prohibited by law if you do not accept this License. Therefore, by modifying or distributing the Program (or any work based on the Program), you indicate your acceptance of this License to do so, and all its terms and conditions for copying, distributing or modifying the Program or works based on it. 6. Each time you redistribute the Program (or any work based on the Program), the recipient automatically receives a license from the original licensor to copy, distribute or modify the Program subject to these terms and conditions. You may not impose any further restrictions on the recipients' exercise of the rights granted herein. You are not responsible for enforcing compliance by third parties to this License. 7. If, as a consequence of a court judgment or allegation of patent infringement or for any other reason (not limited to patent issues), conditions are imposed on you (whether by court order, agreement or otherwise) that contradict the conditions of this License, they do not excuse you from the conditions of this License. If you cannot distribute so as to satisfy simultaneously your obligations under this License and any other pertinent obligations, then as a consequence you may not distribute the Program at all. For example, if a patent license would not permit royalty-free redistribution of the Program by all those who receive copies directly or indirectly through you, then the only way you could satisfy both it and this License would be to refrain entirely from distribution of the Program. If any portion of this section is held invalid or unenforceable under any particular circumstance, the balance of the section is intended to apply and the section as a whole is intended to apply in other circumstances. It is not the purpose of this section to induce you to infringe any patents or other property right claims or to contest validity of any such claims; this section has the sole purpose of protecting the integrity of the free software distribution system, which is implemented by public license practices. Many people have made generous contributions to the wide range of software distributed through that system in reliance on consistent application of that system; it is up to the author/donor to decide if he or she is willing to distribute software through any other system and a licensee cannot impose that choice. This section is intended to make thoroughly clear what is believed to be a consequence of the rest of this License. 8. If the distribution and/or use of the Program is restricted in certain countries either by patents or by copyrighted interfaces, the original copyright holder who places the Program under this License may add an explicit geographical distribution limitation excluding those countries, so that distribution is permitted only in or among countries not thus excluded. In such case, this License incorporates the limitation as if written in the body of this License. 9. The Free Software Foundation may publish revised and/or new versions of the General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. Each version is given a distinguishing version number. If the Program specifies a version number of this License which applies to it and "any later version", you have the option of following the terms and conditions either of that version or of any later version published by the Free Software Foundation. If the Program does not specify a version number of this License, you may choose any version ever published by the Free Software Foundation. 10. If you wish to incorporate parts of the Program into other free programs whose distribution conditions are different, write to the author to ask for permission. For software which is copyrighted by the Free Software Foundation, write to the Free Software Foundation; we sometimes make exceptions for this. Our decision will be guided by the two goals of preserving the free status of all derivatives of our free software and of promoting the sharing and reuse of software generally. NO WARRANTY 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. END OF TERMS AND CONDITIONS How to Apply These Terms to Your New Programs ============================================= If you develop a new program, and you want it to be of the greatest possible use to the public, the best way to achieve this is to make it free software which everyone can redistribute and change under these terms. To do so, attach the following notices to the program. It is safest to attach them to the start of each source file to most effectively convey the exclusion of warranty; and each file should have at least the "copyright" line and a pointer to where the full notice is found. ONE LINE TO GIVE THE PROGRAM'S NAME AND AN IDEA OF WHAT IT DOES. Copyright (C) 19YY NAME OF AUTHOR This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111, USA. Also add information on how to contact you by electronic and paper mail. If the program is interactive, make it output a short notice like this when it starts in an interactive mode: Gnomovision version 69, Copyright (C) 19YY NAME OF AUTHOR Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. This is free software, and you are welcome to redistribute it under certain conditions; type `show c' for details. The hypothetical commands `show w' and `show c' should show the appropriate parts of the General Public License. Of course, the commands you use may be called something other than `show w' and `show c'; they could even be mouse-clicks or menu items--whatever suits your program. You should also get your employer (if you work as a programmer) or your school, if any, to sign a "copyright disclaimer" for the program, if necessary. Here is a sample; alter the names: Yoyodyne, Inc., hereby disclaims all copyright interest in the program `Gnomovision' (which makes passes at compilers) written by James Hacker. SIGNATURE OF TY COON, 1 April 1989 Ty Coon, President of Vice This General Public License does not permit incorporating your program into proprietary programs. If your program is a subroutine library, you may consider it more useful to permit linking proprietary applications with the library. If this is what you want to do, use the GNU Library General Public License instead of this License. Introduction ************ Most of the GNU Emacs text editor is written in the programming language called Emacs Lisp. You can write new code in Emacs Lisp and install it as an extension to the editor. However, Emacs Lisp is more than a mere "extension language"; it is a full computer programming language in its own right. You can use it as you would any other programming language. Because Emacs Lisp is designed for use in an editor, it has special features for scanning and parsing text as well as features for handling files, buffers, displays, subprocesses, and so on. Emacs Lisp is closely integrated with the editing facilities; thus, editing commands are functions that can also conveniently be called from Lisp programs, and parameters for customization are ordinary Lisp variables. This manual attempts to be a full description of Emacs Lisp. For a beginner's introduction to Emacs Lisp, see `An Introduction to Emacs Lisp Programming', by Bob Chassell, also published by the Free Software Foundation. This manual presumes considerable familiarity with the use of Emacs for editing; see `The GNU Emacs Manual' for this basic information. Generally speaking, the earlier chapters describe features of Emacs Lisp that have counterparts in many programming languages, and later chapters describe features that are peculiar to Emacs Lisp or relate specifically to editing. This is edition 2.5. Caveats ======= This manual has gone through numerous drafts. It is nearly complete but not flawless. There are a few topics that are not covered, either because we consider them secondary (such as most of the individual modes) or because they are yet to be written. Because we are not able to deal with them completely, we have left out several parts intentionally. This includes most information about usage on VMS. The manual should be fully correct in what it does cover, and it is therefore open to criticism on anything it says--from specific examples and descriptive text, to the ordering of chapters and sections. If something is confusing, or you find that you have to look at the sources or experiment to learn something not covered in the manual, then perhaps the manual should be fixed. Please let us know. As you use this manual, we ask that you send corrections as soon as you find them. If you think of a simple, real life example for a function or group of functions, please make an effort to write it up and send it in. Please reference any comments to the node name and function or variable name, as appropriate. Also state the number of the edition which you are criticizing. Please mail comments and corrections to bug-lisp-manual@gnu.org We let mail to this list accumulate unread until someone decides to apply the corrections. Months, and sometimes years, go by between updates. So please attach no significance to the lack of a reply--your mail *will* be acted on in due time. If you want to contact the Emacs maintainers more quickly, send mail to `bug-gnu-emacs@gnu.org'. Lisp History ============ Lisp (LISt Processing language) was first developed in the late 1950s at the Massachusetts Institute of Technology for research in artificial intelligence. The great power of the Lisp language makes it ideal for other purposes as well, such as writing editing commands. Dozens of Lisp implementations have been built over the years, each with its own idiosyncrasies. Many of them were inspired by Maclisp, which was written in the 1960s at MIT's Project MAC. Eventually the implementors of the descendants of Maclisp came together and developed a standard for Lisp systems, called Common Lisp. In the meantime, Gerry Sussman and Guy Steele at MIT developed a simplified but very powerful dialect of Lisp, called Scheme. GNU Emacs Lisp is largely inspired by Maclisp, and a little by Common Lisp. If you know Common Lisp, you will notice many similarities. However, many features of Common Lisp have been omitted or simplified in order to reduce the memory requirements of GNU Emacs. Sometimes the simplifications are so drastic that a Common Lisp user might be very confused. We will occasionally point out how GNU Emacs Lisp differs from Common Lisp. If you don't know Common Lisp, don't worry about it; this manual is self-contained. A certain amount of Common Lisp emulation is available via the `cl' library *Note Common Lisp Extension: (cl)Top. Emacs Lisp is not at all influenced by Scheme; but the GNU project has an implementation of Scheme, called Guile. We use Guile in all new GNU software that calls for extensibility. Conventions =========== This section explains the notational conventions that are used in this manual. You may want to skip this section and refer back to it later. Some Terms ---------- Throughout this manual, the phrases "the Lisp reader" and "the Lisp printer" refer to those routines in Lisp that convert textual representations of Lisp objects into actual Lisp objects, and vice versa. *Note Printed Representation::, for more details. You, the person reading this manual, are thought of as "the programmer" and are addressed as "you". "The user" is the person who uses Lisp programs, including those you write. Examples of Lisp code appear in this font or form: `(list 1 2 3)'. Names that represent metasyntactic variables, or arguments to a function being described, appear in this font or form: FIRST-NUMBER. `nil' and `t' ------------- In Lisp, the symbol `nil' has three separate meanings: it is a symbol with the name `nil'; it is the logical truth value FALSE; and it is the empty list--the list of zero elements. When used as a variable, `nil' always has the value `nil'. As far as the Lisp reader is concerned, `()' and `nil' are identical: they stand for the same object, the symbol `nil'. The different ways of writing the symbol are intended entirely for human readers. After the Lisp reader has read either `()' or `nil', there is no way to determine which representation was actually written by the programmer. In this manual, we use `()' when we wish to emphasize that it means the empty list, and we use `nil' when we wish to emphasize that it means the truth value FALSE. That is a good convention to use in Lisp programs also. (cons 'foo ()) ; Emphasize the empty list (not nil) ; Emphasize the truth value FALSE In contexts where a truth value is expected, any non-`nil' value is considered to be TRUE. However, `t' is the preferred way to represent the truth value TRUE. When you need to choose a value which represents TRUE, and there is no other basis for choosing, use `t'. The symbol `t' always has the value `t'. In Emacs Lisp, `nil' and `t' are special symbols that always evaluate to themselves. This is so that you do not need to quote them to use them as constants in a program. An attempt to change their values results in a `setting-constant' error. The same is true of any symbol whose name starts with a colon (`:'). *Note Constant Variables::. Evaluation Notation ------------------- A Lisp expression that you can evaluate is called a "form". Evaluating a form always produces a result, which is a Lisp object. In the examples in this manual, this is indicated with `=>': (car '(1 2)) => 1 You can read this as "`(car '(1 2))' evaluates to 1". When a form is a macro call, it expands into a new form for Lisp to evaluate. We show the result of the expansion with `==>'. We may or may not show the result of the evaluation of the expanded form. (third '(a b c)) ==> (car (cdr (cdr '(a b c)))) => c Sometimes to help describe one form we show another form that produces identical results. The exact equivalence of two forms is indicated with `=='. (make-sparse-keymap) == (list 'keymap) Printing Notation ----------------- Many of the examples in this manual print text when they are evaluated. If you execute example code in a Lisp Interaction buffer (such as the buffer `*scratch*'), the printed text is inserted into the buffer. If you execute the example by other means (such as by evaluating the function `eval-region'), the printed text is displayed in the echo area. You should be aware that text displayed in the echo area is truncated to a single line. Examples in this manual indicate printed text with `-|', irrespective of where that text goes. The value returned by evaluating the form (here `bar') follows on a separate line. (progn (print 'foo) (print 'bar)) -| foo -| bar => bar Error Messages -------------- Some examples signal errors. This normally displays an error message in the echo area. We show the error message on a line starting with `error-->'. Note that `error-->' itself does not appear in the echo area. (+ 23 'x) error--> Wrong type argument: number-or-marker-p, x Buffer Text Notation -------------------- Some examples show modifications to text in a buffer, with "before" and "after" versions of the text. These examples show the contents of the buffer in question between two lines of dashes containing the buffer name. In addition, `-!-' indicates the location of point. (The symbol for point, of course, is not part of the text in the buffer; it indicates the place *between* two characters where point is currently located.) ---------- Buffer: foo ---------- This is the -!-contents of foo. ---------- Buffer: foo ---------- (insert "changed ") => nil ---------- Buffer: foo ---------- This is the changed -!-contents of foo. ---------- Buffer: foo ---------- Format of Descriptions ---------------------- Functions, variables, macros, commands, user options, and special forms are described in this manual in a uniform format. The first line of a description contains the name of the item followed by its arguments, if any. The category--function, variable, or whatever--appears at the beginning of the line. The description follows on succeeding lines, sometimes with examples. A Sample Function Description ............................. In a function description, the name of the function being described appears first. It is followed on the same line by a list of argument names. These names are also used in the body of the description, to stand for the values of the arguments. The appearance of the keyword `&optional' in the argument list indicates that the subsequent arguments may be omitted (omitted arguments default to `nil'). Do not write `&optional' when you call the function. The keyword `&rest' (which must be followed by a single argument name) indicates that any number of arguments can follow. The single following argument name will have a value, as a variable, which is a list of all these remaining arguments. Do not write `&rest' when you call the function. Here is a description of an imaginary function `foo': - Function: foo INTEGER1 &optional INTEGER2 &rest INTEGERS The function `foo' subtracts INTEGER1 from INTEGER2, then adds all the rest of the arguments to the result. If INTEGER2 is not supplied, then the number 19 is used by default. (foo 1 5 3 9) => 16 (foo 5) => 14 More generally, (foo W X Y...) == (+ (- X W) Y...) Any argument whose name contains the name of a type (e.g., INTEGER, INTEGER1 or BUFFER) is expected to be of that type. A plural of a type (such as BUFFERS) often means a list of objects of that type. Arguments named OBJECT may be of any type. (*Note Lisp Data Types::, for a list of Emacs object types.) Arguments with other sorts of names (e.g., NEW-FILE) are discussed specifically in the description of the function. In some sections, features common to the arguments of several functions are described at the beginning. *Note Lambda Expressions::, for a more complete description of optional and rest arguments. Command, macro, and special form descriptions have the same format, but the word `Function' is replaced by `Command', `Macro', or `Special Form', respectively. Commands are simply functions that may be called interactively; macros process their arguments differently from functions (the arguments are not evaluated), but are presented the same way. Special form descriptions use a more complex notation to specify optional and repeated arguments because they can break the argument list down into separate arguments in more complicated ways. `[OPTIONAL-ARG]' means that OPTIONAL-ARG is optional and `REPEATED-ARGS...' stands for zero or more arguments. Parentheses are used when several arguments are grouped into additional levels of list structure. Here is an example: - Special Form: count-loop (VAR [FROM TO [INC]]) BODY... This imaginary special form implements a loop that executes the BODY forms and then increments the variable VAR on each iteration. On the first iteration, the variable has the value FROM; on subsequent iterations, it is incremented by one (or by INC if that is given). The loop exits before executing BODY if VAR equals TO. Here is an example: (count-loop (i 0 10) (prin1 i) (princ " ") (prin1 (aref vector i)) (terpri)) If FROM and TO are omitted, VAR is bound to `nil' before the loop begins, and the loop exits if VAR is non-`nil' at the beginning of an iteration. Here is an example: (count-loop (done) (if (pending) (fixit) (setq done t))) In this special form, the arguments FROM and TO are optional, but must both be present or both absent. If they are present, INC may optionally be specified as well. These arguments are grouped with the argument VAR into a list, to distinguish them from BODY, which includes all remaining elements of the form. A Sample Variable Description ............................. A "variable" is a name that can hold a value. Although any variable can be set by the user, certain variables that exist specifically so that users can change them are called "user options". Ordinary variables and user options are described using a format like that for functions except that there are no arguments. Here is a description of the imaginary `electric-future-map' variable. - Variable: electric-future-map The value of this variable is a full keymap used by Electric Command Future mode. The functions in this map allow you to edit commands you have not yet thought about executing. User option descriptions have the same format, but `Variable' is replaced by `User Option'. Version Information =================== These facilities provide information about which version of Emacs is in use. - Command: emacs-version This function returns a string describing the version of Emacs that is running. It is useful to include this string in bug reports. (emacs-version) => "GNU Emacs 20.3.5 (i486-pc-linux-gnulibc1, X toolkit) of Sat Feb 14 1998 on psilocin.gnu.org" Called interactively, the function prints the same information in the echo area. - Variable: emacs-build-time The value of this variable indicates the time at which Emacs was built at the local site. It is a list of three integers, like the value of `current-time' (*note Time of Day::.). emacs-build-time => (13623 62065 344633) - Variable: emacs-version The value of this variable is the version of Emacs being run. It is a string such as `"20.3.1"'. The last number in this string is not really part of the Emacs release version number; it is incremented each time you build Emacs in any given directory. The following two variables have existed since Emacs version 19.23: - Variable: emacs-major-version The major version number of Emacs, as an integer. For Emacs version 20.3, the value is 20. - Variable: emacs-minor-version The minor version number of Emacs, as an integer. For Emacs version 20.3, the value is 3. Acknowledgements ================ This manual was written by Robert Krawitz, Bil Lewis, Dan LaLiberte, Richard M. Stallman and Chris Welty, the volunteers of the GNU manual group, in an effort extending over several years. Robert J. Chassell helped to review and edit the manual, with the support of the Defense Advanced Research Projects Agency, ARPA Order 6082, arranged by Warren A. Hunt, Jr. of Computational Logic, Inc. Corrections were supplied by Karl Berry, Jim Blandy, Bard Bloom, Stephane Boucher, David Boyes, Alan Carroll, Richard Davis, Lawrence R. Dodd, Peter Doornbosch, David A. Duff, Chris Eich, Beverly Erlebacher, David Eckelkamp, Ralf Fassel, Eirik Fuller, Stephen Gildea, Bob Glickstein, Eric Hanchrow, George Hartzell, Nathan Hess, Masayuki Ida, Dan Jacobson, Jak Kirman, Bob Knighten, Frederick M. Korz, Joe Lammens, Glenn M. Lewis, K. Richard Magill, Brian Marick, Roland McGrath, Skip Montanaro, John Gardiner Myers, Thomas A. Peterson, Francesco Potorti, Friedrich Pukelsheim, Arnold D. Robbins, Raul Rockwell, Per Starback, Shinichirou Sugou, Kimmo Suominen, Edward Tharp, Bill Trost, Rickard Westman, Jean White, Matthew Wilding, Carl Witty, Dale Worley, Rusty Wright, and David D. Zuhn. Lisp Data Types *************** A Lisp "object" is a piece of data used and manipulated by Lisp programs. For our purposes, a "type" or "data type" is a set of possible objects. Every object belongs to at least one type. Objects of the same type have similar structures and may usually be used in the same contexts. Types can overlap, and objects can belong to two or more types. Consequently, we can ask whether an object belongs to a particular type, but not for "the" type of an object. A few fundamental object types are built into Emacs. These, from which all other types are constructed, are called "primitive types". Each object belongs to one and only one primitive type. These types include "integer", "float", "cons", "symbol", "string", "vector", "subr", "byte-code function", plus several special types, such as "buffer", that are related to editing. (*Note Editing Types::.) Each primitive type has a corresponding Lisp function that checks whether an object is a member of that type. Note that Lisp is unlike many other languages in that Lisp objects are "self-typing": the primitive type of the object is implicit in the object itself. For example, if an object is a vector, nothing can treat it as a number; Lisp knows it is a vector, not a number. In most languages, the programmer must declare the data type of each variable, and the type is known by the compiler but not represented in the data. Such type declarations do not exist in Emacs Lisp. A Lisp variable can have any type of value, and it remembers whatever value you store in it, type and all. This chapter describes the purpose, printed representation, and read syntax of each of the standard types in GNU Emacs Lisp. Details on how to use these types can be found in later chapters. Printed Representation and Read Syntax ====================================== The "printed representation" of an object is the format of the output generated by the Lisp printer (the function `prin1') for that object. The "read syntax" of an object is the format of the input accepted by the Lisp reader (the function `read') for that object. *Note Read and Print::. Most objects have more than one possible read syntax. Some types of object have no read syntax, since it may not make sense to enter objects of these types directly in a Lisp program. Except for these cases, the printed representation of an object is also a read syntax for it. In other languages, an expression is text; it has no other form. In Lisp, an expression is primarily a Lisp object and only secondarily the text that is the object's read syntax. Often there is no need to emphasize this distinction, but you must keep it in the back of your mind, or you will occasionally be very confused. Every type has a printed representation. Some types have no read syntax--for example, the buffer type has none. Objects of these types are printed in "hash notation": the characters `#<' followed by a descriptive string (typically the type name followed by the name of the object), and closed with a matching `>'. Hash notation cannot be read at all, so the Lisp reader signals the error `invalid-read-syntax' whenever it encounters `#<'. (current-buffer) => # When you evaluate an expression interactively, the Lisp interpreter first reads the textual representation of it, producing a Lisp object, and then evaluates that object (*note Evaluation::.). However, evaluation and reading are separate activities. Reading returns the Lisp object represented by the text that is read; the object may or may not be evaluated later. *Note Input Functions::, for a description of `read', the basic function for reading objects. Comments ======== A "comment" is text that is written in a program only for the sake of humans that read the program, and that has no effect on the meaning of the program. In Lisp, a semicolon (`;') starts a comment if it is not within a string or character constant. The comment continues to the end of line. The Lisp reader discards comments; they do not become part of the Lisp objects which represent the program within the Lisp system. The `#@COUNT' construct, which skips the next COUNT characters, is useful for program-generated comments containing binary data. The Emacs Lisp byte compiler uses this in its output files (*note Byte Compilation::.). It isn't meant for source files, however. *Note Comment Tips::, for conventions for formatting comments. Programming Types ================= There are two general categories of types in Emacs Lisp: those having to do with Lisp programming, and those having to do with editing. The former exist in many Lisp implementations, in one form or another. The latter are unique to Emacs Lisp. Integer Type ------------ The range of values for integers in Emacs Lisp is -134217728 to 134217727 (28 bits; i.e., -2**27 to 2**27 - 1) on most machines. (Some machines may provide a wider range.) It is important to note that the Emacs Lisp arithmetic functions do not check for overflow. Thus `(1+ 134217727)' is -134217728 on most machines. The read syntax for integers is a sequence of (base ten) digits with an optional sign at the beginning and an optional period at the end. The printed representation produced by the Lisp interpreter never has a leading `+' or a final `.'. -1 ; The integer -1. 1 ; The integer 1. 1. ; Also The integer 1. +1 ; Also the integer 1. 268435457 ; Also the integer 1 on a 28-bit implementation. *Note Numbers::, for more information. Floating Point Type ------------------- Emacs supports floating point numbers (though there is a compilation option to disable them). The precise range of floating point numbers is machine-specific. The printed representation for floating point numbers requires either a decimal point (with at least one digit following), an exponent, or both. For example, `1500.0', `15e2', `15.0e2', `1.5e3', and `.15e4' are five ways of writing a floating point number whose value is 1500. They are all equivalent. *Note Numbers::, for more information. Character Type -------------- A "character" in Emacs Lisp is nothing more than an integer. In other words, characters are represented by their character codes. For example, the character `A' is represented as the integer 65. Individual characters are not often used in programs. It is far more common to work with *strings*, which are sequences composed of characters. *Note String Type::. Characters in strings, buffers, and files are currently limited to the range of 0 to 524287--nineteen bits. But not all values in that range are valid character codes. Codes 0 through 127 are ASCII codes; the rest are non-ASCII (*note Non-ASCII Characters::.). Characters that represent keyboard input have a much wider range, to encode modifier keys such as Control, Meta and Shift. Since characters are really integers, the printed representation of a character is a decimal number. This is also a possible read syntax for a character, but writing characters that way in Lisp programs is a very bad idea. You should *always* use the special read syntax formats that Emacs Lisp provides for characters. These syntax formats start with a question mark. The usual read syntax for alphanumeric characters is a question mark followed by the character; thus, `?A' for the character `A', `?B' for the character `B', and `?a' for the character `a'. For example: ?Q => 81 ?q => 113 You can use the same syntax for punctuation characters, but it is often a good idea to add a `\' so that the Emacs commands for editing Lisp code don't get confused. For example, `?\ ' is the way to write the space character. If the character is `\', you *must* use a second `\' to quote it: `?\\'. You can express the characters Control-g, backspace, tab, newline, vertical tab, formfeed, return, and escape as `?\a', `?\b', `?\t', `?\n', `?\v', `?\f', `?\r', `?\e', respectively. Thus, ?\a => 7 ; `C-g' ?\b => 8 ; backspace, , `C-h' ?\t => 9 ; tab, , `C-i' ?\n => 10 ; newline, `C-j' ?\v => 11 ; vertical tab, `C-k' ?\f => 12 ; formfeed character, `C-l' ?\r => 13 ; carriage return, , `C-m' ?\e => 27 ; escape character, , `C-[' ?\\ => 92 ; backslash character, `\' These sequences which start with backslash are also known as "escape sequences", because backslash plays the role of an escape character; this usage has nothing to do with the character . Control characters may be represented using yet another read syntax. This consists of a question mark followed by a backslash, caret, and the corresponding non-control character, in either upper or lower case. For example, both `?\^I' and `?\^i' are valid read syntax for the character `C-i', the character whose value is 9. Instead of the `^', you can use `C-'; thus, `?\C-i' is equivalent to `?\^I' and to `?\^i': ?\^I => 9 ?\C-I => 9 In strings and buffers, the only control characters allowed are those that exist in ASCII; but for keyboard input purposes, you can turn any character into a control character with `C-'. The character codes for these non-ASCII control characters include the 2**26 bit as well as the code for the corresponding non-control character. Ordinary terminals have no way of generating non-ASCII control characters, but you can generate them straightforwardly using X and other window systems. For historical reasons, Emacs treats the character as the control equivalent of `?': ?\^? => 127 ?\C-? => 127 As a result, it is currently not possible to represent the character `Control-?', which is a meaningful input character under X, using `\C-'. It is not easy to change this, as various Lisp files refer to in this way. For representing control characters to be found in files or strings, we recommend the `^' syntax; for control characters in keyboard input, we prefer the `C-' syntax. Which one you use does not affect the meaning of the program, but may guide the understanding of people who read it. A "meta character" is a character typed with the modifier key. The integer that represents such a character has the 2**27 bit set (which on most machines makes it a negative number). We use high bits for this and other modifiers to make possible a wide range of basic character codes. In a string, the 2**7 bit attached to an ASCII character indicates a meta character; thus, the meta characters that can fit in a string have codes in the range from 128 to 255, and are the meta versions of the ordinary ASCII characters. (In Emacs versions 18 and older, this convention was used for characters outside of strings as well.) The read syntax for meta characters uses `\M-'. For example, `?\M-A' stands for `M-A'. You can use `\M-' together with octal character codes (see below), with `\C-', or with any other syntax for a character. Thus, you can write `M-A' as `?\M-A', or as `?\M-\101'. Likewise, you can write `C-M-b' as `?\M-\C-b', `?\C-\M-b', or `?\M-\002'. The case of a graphic character is indicated by its character code; for example, ASCII distinguishes between the characters `a' and `A'. But ASCII has no way to represent whether a control character is upper case or lower case. Emacs uses the 2**25 bit to indicate that the shift key was used in typing a control character. This distinction is possible only when you use X terminals or other special terminals; ordinary terminals do not report the distinction to the computer in any way. The X Window System defines three other modifier bits that can be set in a character: "hyper", "super" and "alt". The syntaxes for these bits are `\H-', `\s-' and `\A-'. (Case is significant in these prefixes.) Thus, `?\H-\M-\A-x' represents `Alt-Hyper-Meta-x'. Numerically, the bit values are 2**22 for alt, 2**23 for super and 2**24 for hyper. Finally, the most general read syntax for a character represents the character code in either octal or hex. To use octal, write a question mark followed by a backslash and the octal character code (up to three octal digits); thus, `?\101' for the character `A', `?\001' for the character `C-a', and `?\002' for the character `C-b'. Although this syntax can represent any ASCII character, it is preferred only when the precise octal value is more important than the ASCII representation. ?\012 => 10 ?\n => 10 ?\C-j => 10 ?\101 => 65 ?A => 65 To use hex, write a question mark followed by a backslash, `x', and the hexadecimal character code. You can use any number of hex digits, so you can represent any character code in this way. Thus, `?\x41' for the character `A', `?\x1' for the character `C-a', and `?\x8e0' for the character `a' with grave accent. A backslash is allowed, and harmless, preceding any character without a special escape meaning; thus, `?\+' is equivalent to `?+'. There is no reason to add a backslash before most characters. However, you should add a backslash before any of the characters `()\|;'`"#.,' to avoid confusing the Emacs commands for editing Lisp code. Also add a backslash before whitespace characters such as space, tab, newline and formfeed. However, it is cleaner to use one of the easily readable escape sequences, such as `\t', instead of an actual whitespace character such as a tab. Symbol Type ----------- A "symbol" in GNU Emacs Lisp is an object with a name. The symbol name serves as the printed representation of the symbol. In ordinary use, the name is unique--no two symbols have the same name. A symbol can serve as a variable, as a function name, or to hold a property list. Or it may serve only to be distinct from all other Lisp objects, so that its presence in a data structure may be recognized reliably. In a given context, usually only one of these uses is intended. But you can use one symbol in all of these ways, independently. A symbol name can contain any characters whatever. Most symbol names are written with letters, digits, and the punctuation characters `-+=*/'. Such names require no special punctuation; the characters of the name suffice as long as the name does not look like a number. (If it does, write a `\' at the beginning of the name to force interpretation as a symbol.) The characters `_~!@$%^&:<>{}' are less often used but also require no special punctuation. Any other characters may be included in a symbol's name by escaping them with a backslash. In contrast to its use in strings, however, a backslash in the name of a symbol simply quotes the single character that follows the backslash. For example, in a string, `\t' represents a tab character; in the name of a symbol, however, `\t' merely quotes the letter `t'. To have a symbol with a tab character in its name, you must actually use a tab (preceded with a backslash). But it's rare to do such a thing. Common Lisp note: In Common Lisp, lower case letters are always "folded" to upper case, unless they are explicitly escaped. In Emacs Lisp, upper case and lower case letters are distinct. Here are several examples of symbol names. Note that the `+' in the fifth example is escaped to prevent it from being read as a number. This is not necessary in the sixth example because the rest of the name makes it invalid as a number. foo ; A symbol named `foo'. FOO ; A symbol named `FOO', different from `foo'. char-to-string ; A symbol named `char-to-string'. 1+ ; A symbol named `1+' ; (not `+1', which is an integer). \+1 ; A symbol named `+1' ; (not a very readable name). \(*\ 1\ 2\) ; A symbol named `(* 1 2)' (a worse name). +-*/_~!@$%^&=:<>{} ; A symbol named `+-*/_~!@$%^&=:<>{}'. ; These characters need not be escaped. Sequence Types -------------- A "sequence" is a Lisp object that represents an ordered set of elements. There are two kinds of sequence in Emacs Lisp, lists and arrays. Thus, an object of type list or of type array is also considered a sequence. Arrays are further subdivided into strings, vectors, char-tables and bool-vectors. Vectors can hold elements of any type, but string elements must be characters, and bool-vector elements must be `t' or `nil'. The characters in a string can have text properties like characters in a buffer (*note Text Properties::.); vectors and bool-vectors do not support text properties even when their elements happen to be characters. Char-tables are like vectors except that they are indexed by any valid character code. Lists, strings and the other array types are different, but they have important similarities. For example, all have a length L, and all have elements which can be indexed from zero to L minus one. Several functions, called sequence functions, accept any kind of sequence. For example, the function `elt' can be used to extract an element of a sequence, given its index. *Note Sequences Arrays Vectors::. It is generally impossible to read the same sequence twice, since sequences are always created anew upon reading. If you read the read syntax for a sequence twice, you get two sequences with equal contents. There is one exception: the empty list `()' always stands for the same object, `nil'. Cons Cell and List Types ------------------------ A "cons cell" is an object that consists of two pointers or slots, called the CAR slot and the CDR slot. Each slot can "point to" or hold to any Lisp object. We also say that the "the CAR of this cons cell is" whatever object its CAR slot currently points to, and likewise for the CDR. A "list" is a series of cons cells, linked together so that the CDR slot of each cons cell holds either the next cons cell or the empty list. *Note Lists::, for functions that work on lists. Because most cons cells are used as part of lists, the phrase "list structure" has come to refer to any structure made out of cons cells. The names CAR and CDR derive from the history of Lisp. The original Lisp implementation ran on an IBM 704 computer which divided words into two parts, called the "address" part and the "decrement"; CAR was an instruction to extract the contents of the address part of a register, and CDR an instruction to extract the contents of the decrement. By contrast, "cons cells" are named for the function `cons' that creates them, which in turn is named for its purpose, the construction of cells. Because cons cells are so central to Lisp, we also have a word for "an object which is not a cons cell". These objects are called "atoms". The read syntax and printed representation for lists are identical, and consist of a left parenthesis, an arbitrary number of elements, and a right parenthesis. Upon reading, each object inside the parentheses becomes an element of the list. That is, a cons cell is made for each element. The CAR slot of the cons cell points to the element, and its CDR slot points to the next cons cell of the list, which holds the next element in the list. The CDR slot of the last cons cell is set to point to `nil'. A list can be illustrated by a diagram in which the cons cells are shown as pairs of boxes, like dominoes. (The Lisp reader cannot read such an illustration; unlike the textual notation, which can be understood by both humans and computers, the box illustrations can be understood only by humans.) This picture represents the three-element list `(rose violet buttercup)': --- --- --- --- --- --- | | |--> | | |--> | | |--> nil --- --- --- --- --- --- | | | | | | --> rose --> violet --> buttercup In this diagram, each box represents a slot that can point to any Lisp object. Each pair of boxes represents a cons cell. Each arrow is a pointer to a Lisp object, either an atom or another cons cell. In this example, the first box, which holds the CAR of the first cons cell, points to or "contains" `rose' (a symbol). The second box, holding the CDR of the first cons cell, points to the next pair of boxes, the second cons cell. The CAR of the second cons cell is `violet', and its CDR is the third cons cell. The CDR of the third (and last) cons cell is `nil'. Here is another diagram of the same list, `(rose violet buttercup)', sketched in a different manner: --------------- ---------------- ------------------- | car | cdr | | car | cdr | | car | cdr | | rose | o-------->| violet | o-------->| buttercup | nil | | | | | | | | | | --------------- ---------------- ------------------- A list with no elements in it is the "empty list"; it is identical to the symbol `nil'. In other words, `nil' is both a symbol and a list. Here are examples of lists written in Lisp syntax: (A 2 "A") ; A list of three elements. () ; A list of no elements (the empty list). nil ; A list of no elements (the empty list). ("A ()") ; A list of one element: the string `"A ()"'. (A ()) ; A list of two elements: `A' and the empty list. (A nil) ; Equivalent to the previous. ((A B C)) ; A list of one element ; (which is a list of three elements). Here is the list `(A ())', or equivalently `(A nil)', depicted with boxes and arrows: --- --- --- --- | | |--> | | |--> nil --- --- --- --- | | | | --> A --> nil Dotted Pair Notation .................... "Dotted pair notation" is an alternative syntax for cons cells that represents the CAR and CDR explicitly. In this syntax, `(A . B)' stands for a cons cell whose CAR is the object A, and whose CDR is the object B. Dotted pair notation is therefore more general than list syntax. In the dotted pair notation, the list `(1 2 3)' is written as `(1 . (2 . (3 . nil)))'. For `nil'-terminated lists, you can use either notation, but list notation is usually clearer and more convenient. When printing a list, the dotted pair notation is only used if the CDR of a cons cell is not a list. Here's an example using boxes to illustrate dotted pair notation. This example shows the pair `(rose . violet)': --- --- | | |--> violet --- --- | | --> rose You can combine dotted pair notation with list notation to represent conveniently a chain of cons cells with a non-`nil' final CDR. You write a dot after the last element of the list, followed by the CDR of the final cons cell. For example, `(rose violet . buttercup)' is equivalent to `(rose . (violet . buttercup))'. The object looks like this: --- --- --- --- | | |--> | | |--> buttercup --- --- --- --- | | | | --> rose --> violet The syntax `(rose . violet . buttercup)' is invalid because there is nothing that it could mean. If anything, it would say to put `buttercup' in the CDR of a cons cell whose CDR is already used for `violet'. The list `(rose violet)' is equivalent to `(rose . (violet))', and looks like this: --- --- --- --- | | |--> | | |--> nil --- --- --- --- | | | | --> rose --> violet Similarly, the three-element list `(rose violet buttercup)' is equivalent to `(rose . (violet . (buttercup)))'. It looks like this: --- --- --- --- --- --- | | |--> | | |--> | | |--> nil --- --- --- --- --- --- | | | | | | --> rose --> violet --> buttercup Association List Type ..................... An "association list" or "alist" is a specially-constructed list whose elements are cons cells. In each element, the CAR is considered a "key", and the CDR is considered an "associated value". (In some cases, the associated value is stored in the CAR of the CDR.) Association lists are often used as stacks, since it is easy to add or remove associations at the front of the list. For example, (setq alist-of-colors '((rose . red) (lily . white) (buttercup . yellow))) sets the variable `alist-of-colors' to an alist of three elements. In the first element, `rose' is the key and `red' is the value. *Note Association Lists::, for a further explanation of alists and for functions that work on alists. Array Type ---------- An "array" is composed of an arbitrary number of slots for pointing to other Lisp objects, arranged in a contiguous block of memory. Accessing any element of an array takes approximately the same amount of time. In contrast, accessing an element of a list requires time proportional to the position of the element in the list. (Elements at the end of a list take longer to access than elements at the beginning of a list.) Emacs defines four types of array: strings, vectors, bool-vectors, and char-tables. A string is an array of characters and a vector is an array of arbitrary objects. A bool-vector can hold only `t' or `nil'. These kinds of array may have any length up to the largest integer. Char-tables are sparse arrays indexed by any valid character code; they can hold arbitrary objects. The first element of an array has index zero, the second element has index 1, and so on. This is called "zero-origin" indexing. For example, an array of four elements has indices 0, 1, 2, and 3. The largest possible index value is one less than the length of the array. Once an array is created, its length is fixed. All Emacs Lisp arrays are one-dimensional. (Most other programming languages support multidimensional arrays, but they are not essential; you can get the same effect with an array of arrays.) Each type of array has its own read syntax; see the following sections for details. The array type is contained in the sequence type and contains the string type, the vector type, the bool-vector type, and the char-table type. String Type ----------- A "string" is an array of characters. Strings are used for many purposes in Emacs, as can be expected in a text editor; for example, as the names of Lisp symbols, as messages for the user, and to represent text extracted from buffers. Strings in Lisp are constants: evaluation of a string returns the same string. *Note Strings and Characters::, for functions that operate on strings. Syntax for Strings .................. The read syntax for strings is a double-quote, an arbitrary number of characters, and another double-quote, `"like this"'. To include a double-quote in a string, precede it with a backslash; thus, `"\""' is a string containing just a single double-quote character. Likewise, you can include a backslash by preceding it with another backslash, like this: `"this \\ is a single embedded backslash"'. The newline character is not special in the read syntax for strings; if you write a new line between the double-quotes, it becomes a character in the string. But an escaped newline--one that is preceded by `\'--does not become part of the string; i.e., the Lisp reader ignores an escaped newline while reading a string. An escaped space `\ ' is likewise ignored. "It is useful to include newlines in documentation strings, but the newline is \ ignored if escaped." => "It is useful to include newlines in documentation strings, but the newline is ignored if escaped." Non-ASCII Characters in Strings ............................... You can include a non-ASCII international character in a string constant by writing it literally. There are two text representations for non-ASCII characters in Emacs strings (and in buffers): unibyte and multibyte. If the string constant is read from a multibyte source, such as a multibyte buffer or string, or a file that would be visited as multibyte, then the character is read as a multibyte character, and that makes the string multibyte. If the string constant is read from a unibyte source, then the character is read as unibyte and that makes the string unibyte. You can also represent a multibyte non-ASCII character with its character code, using a hex escape, `\xNNNNNNN', with as many digits as necessary. (Multibyte non-ASCII character codes are all greater than 256.) Any character which is not a valid hex digit terminates this construct. If the character that would follow is a hex digit, write `\ ' (backslash and space) to terminate the hex escape--for example, `\x8e0\ ' represents one character, `a' with grave accent. `\ ' in a string constant is just like backslash-newline; it does not contribute any character to the string, but it does terminate the preceding hex escape. Using a multibyte hex escape forces the string to multibyte. You can represent a unibyte non-ASCII character with its character code, which must be in the range from 128 (0200 octal) to 255 (0377 octal). This forces a unibyte string. *Note Text Representations::, for more information about the two text representations. Nonprinting Characters in Strings ................................. You can use the same backslash escape-sequences in a string constant as in character literals (but do not use the question mark that begins a character constant). For example, you can write a string containing the nonprinting characters tab and `C-a', with commas and spaces between them, like this: `"\t, \C-a"'. *Note Character Type::, for a description of the read syntax for characters. However, not all of the characters you can write with backslash escape-sequences are valid in strings. The only control characters that a string can hold are the ASCII control characters. Strings do not distinguish case in ASCII control characters. Properly speaking, strings cannot hold meta characters; but when a string is to be used as a key sequence, there is a special convention that provides a way to represent meta versions of ASCII characters in a string. If you use the `\M-' syntax to indicate a meta character in a string constant, this sets the 2**7 bit of the character in the string. If the string is used in `define-key' or `lookup-key', this numeric code is translated into the equivalent meta character. *Note Character Type::. Strings cannot hold characters that have the hyper, super, or alt modifiers. Text Properties in Strings .......................... A string can hold properties for the characters it contains, in addition to the characters themselves. This enables programs that copy text between strings and buffers to copy the text's properties with no special effort. *Note Text Properties::, for an explanation of what text properties mean. Strings with text properties use a special read and print syntax: #("CHARACTERS" PROPERTY-DATA...) where PROPERTY-DATA consists of zero or more elements, in groups of three as follows: BEG END PLIST The elements BEG and END are integers, and together specify a range of indices in the string; PLIST is the property list for that range. For example, #("foo bar" 0 3 (face bold) 3 4 nil 4 7 (face italic)) represents a string whose textual contents are `foo bar', in which the first three characters have a `face' property with value `bold', and the last three have a `face' property with value `italic'. (The fourth character has no text properties, so its property list is `nil'. It is not actually necessary to mention ranges with `nil' as the property list, since any characters not mentioned in any range will default to having no properties.) Vector Type ----------- A "vector" is a one-dimensional array of elements of any type. It takes a constant amount of time to access any element of a vector. (In a list, the access time of an element is proportional to the distance of the element from the beginning of the list.) The printed representation of a vector consists of a left square bracket, the elements, and a right square bracket. This is also the read syntax. Like numbers and strings, vectors are considered constants for evaluation. [1 "two" (three)] ; A vector of three elements. => [1 "two" (three)] *Note Vectors::, for functions that work with vectors. Char-Table Type --------------- A "char-table" is a one-dimensional array of elements of any type, indexed by character codes. Char-tables have certain extra features to make them more useful for many jobs that involve assigning information to character codes--for example, a char-table can have a parent to inherit from, a default value, and a small number of extra slots to use for special purposes. A char-table can also specify a single value for a whole character set. The printed representation of a char-table is like a vector except that there is an extra `#^' at the beginning. *Note Char-Tables::, for special functions to operate on char-tables. Uses of char-tables include: * Case tables (*note Case Tables::.). * Character category tables (*note Categories::.). * Display Tables (*note Display Tables::.). * Syntax tables (*note Syntax Tables::.). Bool-Vector Type ---------------- A "bool-vector" is a one-dimensional array of elements that must be `t' or `nil'. The printed representation of a Bool-vector is like a string, except that it begins with `#&' followed by the length. The string constant that follows actually specifies the contents of the bool-vector as a bitmap--each "character" in the string contains 8 bits, which specify the next 8 elements of the bool-vector (1 stands for `t', and 0 for `nil'). The least significant bits of the character correspond to the lowest indices in the bool-vector. If the length is not a multiple of 8, the printed representation shows extra elements, but these extras really make no difference. (make-bool-vector 3 t) => #&3"\007" (make-bool-vector 3 nil) => #&3"\0" ;; These are equal since only the first 3 bits are used. (equal #&3"\377" #&3"\007") => t Function Type ------------- Just as functions in other programming languages are executable, "Lisp function" objects are pieces of executable code. However, functions in Lisp are primarily Lisp objects, and only secondarily the text which represents them. These Lisp objects are lambda expressions: lists whose first element is the symbol `lambda' (*note Lambda Expressions::.). In most programming languages, it is impossible to have a function without a name. In Lisp, a function has no intrinsic name. A lambda expression is also called an "anonymous function" (*note Anonymous Functions::.). A named function in Lisp is actually a symbol with a valid function in its function cell (*note Defining Functions::.). Most of the time, functions are called when their names are written in Lisp expressions in Lisp programs. However, you can construct or obtain a function object at run time and then call it with the primitive functions `funcall' and `apply'. *Note Calling Functions::. Macro Type ---------- A "Lisp macro" is a user-defined construct that extends the Lisp language. It is represented as an object much like a function, but with different argument-passing semantics. A Lisp macro has the form of a list whose first element is the symbol `macro' and whose CDR is a Lisp function object, including the `lambda' symbol. Lisp macro objects are usually defined with the built-in `defmacro' function, but any list that begins with `macro' is a macro as far as Emacs is concerned. *Note Macros::, for an explanation of how to write a macro. *Warning*: Lisp macros and keyboard macros (*note Keyboard Macros::.) are entirely different things. When we use the word "macro" without qualification, we mean a Lisp macro, not a keyboard macro. Primitive Function Type ----------------------- A "primitive function" is a function callable from Lisp but written in the C programming language. Primitive functions are also called "subrs" or "built-in functions". (The word "subr" is derived from "subroutine".) Most primitive functions evaluate all their arguments when they are called. A primitive function that does not evaluate all its arguments is called a "special form" (*note Special Forms::.). It does not matter to the caller of a function whether the function is primitive. However, this does matter if you try to redefine a primitive with a function written in Lisp. The reason is that the primitive function may be called directly from C code. Calls to the redefined function from Lisp will use the new definition, but calls from C code may still use the built-in definition. Therefore, *we discourage redefinition of primitive functions*. The term "function" refers to all Emacs functions, whether written in Lisp or C. *Note Function Type::, for information about the functions written in Lisp. Primitive functions have no read syntax and print in hash notation with the name of the subroutine. (symbol-function 'car) ; Access the function cell ; of the symbol. => # (subrp (symbol-function 'car)) ; Is this a primitive function? => t ; Yes. Byte-Code Function Type ----------------------- The byte compiler produces "byte-code function objects". Internally, a byte-code function object is much like a vector; however, the evaluator handles this data type specially when it appears as a function to be called. *Note Byte Compilation::, for information about the byte compiler. The printed representation and read syntax for a byte-code function object is like that for a vector, with an additional `#' before the opening `['. Autoload Type ------------- An "autoload object" is a list whose first element is the symbol `autoload'. It is stored as the function definition of a symbol as a placeholder for the real definition; it says that the real definition is found in a file of Lisp code that should be loaded when necessary. The autoload object contains the name of the file, plus some other information about the real definition. After the file has been loaded, the symbol should have a new function definition that is not an autoload object. The new definition is then called as if it had been there to begin with. From the user's point of view, the function call works as expected, using the function definition in the loaded file. An autoload object is usually created with the function `autoload', which stores the object in the function cell of a symbol. *Note Autoload::, for more details. Editing Types ============= The types in the previous section are used for general programming purposes, and most of them are common to most Lisp dialects. Emacs Lisp provides several additional data types for purposes connected with editing. Buffer Type ----------- A "buffer" is an object that holds text that can be edited (*note Buffers::.). Most buffers hold the contents of a disk file (*note Files::.) so they can be edited, but some are used for other purposes. Most buffers are also meant to be seen by the user, and therefore displayed, at some time, in a window (*note Windows::.). But a buffer need not be displayed in any window. The contents of a buffer are much like a string, but buffers are not used like strings in Emacs Lisp, and the available operations are different. For example, you can insert text efficiently into an existing buffer, whereas "inserting" text into a string requires concatenating substrings, and the result is an entirely new string object. Each buffer has a designated position called "point" (*note Positions::.). At any time, one buffer is the "current buffer". Most editing commands act on the contents of the current buffer in the neighborhood of point. Many of the standard Emacs functions manipulate or test the characters in the current buffer; a whole chapter in this manual is devoted to describing these functions (*note Text::.). Several other data structures are associated with each buffer: * a local syntax table (*note Syntax Tables::.); * a local keymap (*note Keymaps::.); and, * a list of buffer-local variable bindings (*note Buffer-Local Variables::.). * overlays (*note Overlays::.). * text properties for the text in the buffer (*note Text Properties::.). The local keymap and variable list contain entries that individually override global bindings or values. These are used to customize the behavior of programs in different buffers, without actually changing the programs. A buffer may be "indirect", which means it shares the text of another buffer, but presents it differently. *Note Indirect Buffers::. Buffers have no read syntax. They print in hash notation, showing the buffer name. (current-buffer) => # Marker Type ----------- A "marker" denotes a position in a specific buffer. Markers therefore have two components: one for the buffer, and one for the position. Changes in the buffer's text automatically relocate the position value as necessary to ensure that the marker always points between the same two characters in the buffer. Markers have no read syntax. They print in hash notation, giving the current character position and the name of the buffer. (point-marker) => # *Note Markers::, for information on how to test, create, copy, and move markers. Window Type ----------- A "window" describes the portion of the terminal screen that Emacs uses to display a buffer. Every window has one associated buffer, whose contents appear in the window. By contrast, a given buffer may appear in one window, no window, or several windows. Though many windows may exist simultaneously, at any time one window is designated the "selected window". This is the window where the cursor is (usually) displayed when Emacs is ready for a command. The selected window usually displays the current buffer, but this is not necessarily the case. Windows are grouped on the screen into frames; each window belongs to one and only one frame. *Note Frame Type::. Windows have no read syntax. They print in hash notation, giving the window number and the name of the buffer being displayed. The window numbers exist to identify windows uniquely, since the buffer displayed in any given window can change frequently. (selected-window) => # *Note Windows::, for a description of the functions that work on windows. Frame Type ---------- A "frame" is a rectangle on the screen that contains one or more Emacs windows. A frame initially contains a single main window (plus perhaps a minibuffer window) which you can subdivide vertically or horizontally into smaller windows. Frames have no read syntax. They print in hash notation, giving the frame's title, plus its address in core (useful to identify the frame uniquely). (selected-frame) => # *Note Frames::, for a description of the functions that work on frames. Window Configuration Type ------------------------- A "window configuration" stores information about the positions, sizes, and contents of the windows in a frame, so you can recreate the same arrangement of windows later. Window configurations do not have a read syntax; their print syntax looks like `#'. *Note Window Configurations::, for a description of several functions related to window configurations. Frame Configuration Type ------------------------ A "frame configuration" stores information about the positions, sizes, and contents of the windows in all frames. It is actually a list whose CAR is `frame-configuration' and whose CDR is an alist. Each alist element describes one frame, which appears as the CAR of that element. *Note Frame Configurations::, for a description of several functions related to frame configurations. Process Type ------------ The word "process" usually means a running program. Emacs itself runs in a process of this sort. However, in Emacs Lisp, a process is a Lisp object that designates a subprocess created by the Emacs process. Programs such as shells, GDB, ftp, and compilers, running in subprocesses of Emacs, extend the capabilities of Emacs. An Emacs subprocess takes textual input from Emacs and returns textual output to Emacs for further manipulation. Emacs can also send signals to the subprocess. Process objects have no read syntax. They print in hash notation, giving the name of the process: (process-list) => (#) *Note Processes::, for information about functions that create, delete, return information about, send input or signals to, and receive output from processes. Stream Type ----------- A "stream" is an object that can be used as a source or sink for characters--either to supply characters for input or to accept them as output. Many different types can be used this way: markers, buffers, strings, and functions. Most often, input streams (character sources) obtain characters from the keyboard, a buffer, or a file, and output streams (character sinks) send characters to a buffer, such as a `*Help*' buffer, or to the echo area. The object `nil', in addition to its other meanings, may be used as a stream. It stands for the value of the variable `standard-input' or `standard-output'. Also, the object `t' as a stream specifies input using the minibuffer (*note Minibuffers::.) or output in the echo area (*note The Echo Area::.). Streams have no special printed representation or read syntax, and print as whatever primitive type they are. *Note Read and Print::, for a description of functions related to streams, including parsing and printing functions. Keymap Type ----------- A "keymap" maps keys typed by the user to commands. This mapping controls how the user's command input is executed. A keymap is actually a list whose CAR is the symbol `keymap'. *Note Keymaps::, for information about creating keymaps, handling prefix keys, local as well as global keymaps, and changing key bindings. Overlay Type ------------ An "overlay" specifies properties that apply to a part of a buffer. Each overlay applies to a specified range of the buffer, and contains a property list (a list whose elements are alternating property names and values). Overlay properties are used to present parts of the buffer temporarily in a different display style. Overlays have no read syntax, and print in hash notation, giving the buffer name and range of positions. *Note Overlays::, for how to create and use overlays. Type Predicates =============== The Emacs Lisp interpreter itself does not perform type checking on the actual arguments passed to functions when they are called. It could not do so, since function arguments in Lisp do not have declared data types, as they do in other programming languages. It is therefore up to the individual function to test whether each actual argument belongs to a type that the function can use. All built-in functions do check the types of their actual arguments when appropriate, and signal a `wrong-type-argument' error if an argument is of the wrong type. For example, here is what happens if you pass an argument to `+' that it cannot handle: (+ 2 'a) error--> Wrong type argument: number-or-marker-p, a If you want your program to handle different types differently, you must do explicit type checking. The most common way to check the type of an object is to call a "type predicate" function. Emacs has a type predicate for each type, as well as some predicates for combinations of types. A type predicate function takes one argument; it returns `t' if the argument belongs to the appropriate type, and `nil' otherwise. Following a general Lisp convention for predicate functions, most type predicates' names end with `p'. Here is an example which uses the predicates `listp' to check for a list and `symbolp' to check for a symbol. (defun add-on (x) (cond ((symbolp x) ;; If X is a symbol, put it on LIST. (setq list (cons x list))) ((listp x) ;; If X is a list, add its elements to LIST. (setq list (append x list))) (t ;; We handle only symbols and lists. (error "Invalid argument %s in add-on" x)))) Here is a table of predefined type predicates, in alphabetical order, with references to further information. `atom' *Note atom: List-related Predicates. `arrayp' *Note arrayp: Array Functions. `bool-vector-p' *Note bool-vector-p: Bool-Vectors. `bufferp' *Note bufferp: Buffer Basics. `byte-code-function-p' *Note byte-code-function-p: Byte-Code Type. `case-table-p' *Note case-table-p: Case Tables. `char-or-string-p' *Note char-or-string-p: Predicates for Strings. `char-table-p' *Note char-table-p: Char-Tables. `commandp' *Note commandp: Interactive Call. `consp' *Note consp: List-related Predicates. `display-table-p' *Note display-table-p: Display Tables. `floatp' *Note floatp: Predicates on Numbers. `frame-configuration-p' *Note frame-configuration-p: Frame Configurations. `frame-live-p' *Note frame-live-p: Deleting Frames. `framep' *Note framep: Frames. `functionp' *Note functionp: Functions. `integer-or-marker-p' *Note integer-or-marker-p: Predicates on Markers. `integerp' *Note integerp: Predicates on Numbers. `keymapp' *Note keymapp: Creating Keymaps. `listp' *Note listp: List-related Predicates. `markerp' *Note markerp: Predicates on Markers. `wholenump' *Note wholenump: Predicates on Numbers. `nlistp' *Note nlistp: List-related Predicates. `numberp' *Note numberp: Predicates on Numbers. `number-or-marker-p' *Note number-or-marker-p: Predicates on Markers. `overlayp' *Note overlayp: Overlays. `processp' *Note processp: Processes. `sequencep' *Note sequencep: Sequence Functions. `stringp' *Note stringp: Predicates for Strings. `subrp' *Note subrp: Function Cells. `symbolp' *Note symbolp: Symbols. `syntax-table-p' *Note syntax-table-p: Syntax Tables. `user-variable-p' *Note user-variable-p: Defining Variables. `vectorp' *Note vectorp: Vectors. `window-configuration-p' *Note window-configuration-p: Window Configurations. `window-live-p' *Note window-live-p: Deleting Windows. `windowp' *Note windowp: Basic Windows. The most general way to check the type of an object is to call the function `type-of'. Recall that each object belongs to one and only one primitive type; `type-of' tells you which one (*note Lisp Data Types::.). But `type-of' knows nothing about non-primitive types. In most cases, it is more convenient to use type predicates than `type-of'. - Function: type-of OBJECT This function returns a symbol naming the primitive type of OBJECT. The value is one of the symbols `symbol', `integer', `float', `string', `cons', `vector', `char-table', `bool-vector', `subr', `compiled-function', `marker', `overlay', `window', `buffer', `frame', `process', or `window-configuration'. (type-of 1) => integer (type-of 'nil) => symbol (type-of '()) ; `()' is `nil'. => symbol (type-of '(x)) => cons Equality Predicates =================== Here we describe two functions that test for equality between any two objects. Other functions test equality between objects of specific types, e.g., strings. For these predicates, see the appropriate chapter describing the data type. - Function: eq OBJECT1 OBJECT2 This function returns `t' if OBJECT1 and OBJECT2 are the same object, `nil' otherwise. The "same object" means that a change in one will be reflected by the same change in the other. `eq' returns `t' if OBJECT1 and OBJECT2 are integers with the same value. Also, since symbol names are normally unique, if the arguments are symbols with the same name, they are `eq'. For other types (e.g., lists, vectors, strings), two arguments with the same contents or elements are not necessarily `eq' to each other: they are `eq' only if they are the same object. (eq 'foo 'foo) => t (eq 456 456) => t (eq "asdf" "asdf") => nil (eq '(1 (2 (3))) '(1 (2 (3)))) => nil (setq foo '(1 (2 (3)))) => (1 (2 (3))) (eq foo foo) => t (eq foo '(1 (2 (3)))) => nil (eq [(1 2) 3] [(1 2) 3]) => nil (eq (point-marker) (point-marker)) => nil The `make-symbol' function returns an uninterned symbol, distinct from the symbol that is used if you write the name in a Lisp expression. Distinct symbols with the same name are not `eq'. *Note Creating Symbols::. (eq (make-symbol "foo") 'foo) => nil - Function: equal OBJECT1 OBJECT2 This function returns `t' if OBJECT1 and OBJECT2 have equal components, `nil' otherwise. Whereas `eq' tests if its arguments are the same object, `equal' looks inside nonidentical arguments to see if their elements are the same. So, if two objects are `eq', they are `equal', but the converse is not always true. (equal 'foo 'foo) => t (equal 456 456) => t (equal "asdf" "asdf") => t (eq "asdf" "asdf") => nil (equal '(1 (2 (3))) '(1 (2 (3)))) => t (eq '(1 (2 (3))) '(1 (2 (3)))) => nil (equal [(1 2) 3] [(1 2) 3]) => t (eq [(1 2) 3] [(1 2) 3]) => nil (equal (point-marker) (point-marker)) => t (eq (point-marker) (point-marker)) => nil Comparison of strings is case-sensitive, but does not take account of text properties--it compares only the characters in the strings. A unibyte string never equals a multibyte string unless the contents are entirely ASCII (*note Text Representations::.). (equal "asdf" "ASDF") => nil Two distinct buffers are never `equal', even if their contents are the same. The test for equality is implemented recursively, and circular lists may therefore cause infinite recursion (leading to an error). Numbers ******* GNU Emacs supports two numeric data types: "integers" and "floating point numbers". Integers are whole numbers such as -3, 0, 7, 13, and 511. Their values are exact. Floating point numbers are numbers with fractional parts, such as -4.5, 0.0, or 2.71828. They can also be expressed in exponential notation: 1.5e2 equals 150; in this example, `e2' stands for ten to the second power, and that is multiplied by 1.5. Floating point values are not exact; they have a fixed, limited amount of precision. Integer Basics ============== The range of values for an integer depends on the machine. The minimum range is -134217728 to 134217727 (28 bits; i.e., -2**27 to 2**27 - 1), but some machines may provide a wider range. Many examples in this chapter assume an integer has 28 bits. The Lisp reader reads an integer as a sequence of digits with optional initial sign and optional final period. 1 ; The integer 1. 1. ; The integer 1. +1 ; Also the integer 1. -1 ; The integer -1. 268435457 ; Also the integer 1, due to overflow. 0 ; The integer 0. -0 ; The integer 0. To understand how various functions work on integers, especially the bitwise operators (*note Bitwise Operations::.), it is often helpful to view the numbers in their binary form. In 28-bit binary, the decimal integer 5 looks like this: 0000 0000 0000 0000 0000 0000 0101 (We have inserted spaces between groups of 4 bits, and two spaces between groups of 8 bits, to make the binary integer easier to read.) The integer -1 looks like this: 1111 1111 1111 1111 1111 1111 1111 -1 is represented as 28 ones. (This is called "two's complement" notation.) The negative integer, -5, is creating by subtracting 4 from -1. In binary, the decimal integer 4 is 100. Consequently, -5 looks like this: 1111 1111 1111 1111 1111 1111 1011 In this implementation, the largest 28-bit binary integer value is 134,217,727 in decimal. In binary, it looks like this: 0111 1111 1111 1111 1111 1111 1111 Since the arithmetic functions do not check whether integers go outside their range, when you add 1 to 134,217,727, the value is the negative integer -134,217,728: (+ 1 134217727) => -134217728 => 1000 0000 0000 0000 0000 0000 0000 Many of the functions described in this chapter accept markers for arguments in place of numbers. (*Note Markers::.) Since the actual arguments to such functions may be either numbers or markers, we often give these arguments the name NUMBER-OR-MARKER. When the argument value is a marker, its position value is used and its buffer is ignored. Floating Point Basics ===================== Floating point numbers are useful for representing numbers that are not integral. The precise range of floating point numbers is machine-specific; it is the same as the range of the C data type `double' on the machine you are using. The read-syntax for floating point numbers requires either a decimal point (with at least one digit following), an exponent, or both. For example, `1500.0', `15e2', `15.0e2', `1.5e3', and `.15e4' are five ways of writing a floating point number whose value is 1500. They are all equivalent. You can also use a minus sign to write negative floating point numbers, as in `-1.0'. Most modern computers support the IEEE floating point standard, which provides for positive infinity and negative infinity as floating point values. It also provides for a class of values called NaN or "not-a-number"; numerical functions return such values in cases where there is no correct answer. For example, `(sqrt -1.0)' returns a NaN. For practical purposes, there's no significant difference between different NaN values in Emacs Lisp, and there's no rule for precisely which NaN value should be used in a particular case, so Emacs Lisp doesn't try to distinguish them. Here are the read syntaxes for these special floating point values: positive infinity `1.0e+INF' negative infinity `-1.0e+INF' Not-a-number `0.0e+NaN'. In addition, the value `-0.0' is distinguishable from ordinary zero in IEEE floating point (although `equal' and `=' consider them equal values). You can use `logb' to extract the binary exponent of a floating point number (or estimate the logarithm of an integer): - Function: logb NUMBER This function returns the binary exponent of NUMBER. More precisely, the value is the logarithm of NUMBER base 2, rounded down to an integer. (logb 10) => 3 (logb 10.0e20) => 69 Type Predicates for Numbers =========================== The functions in this section test whether the argument is a number or whether it is a certain sort of number. The functions `integerp' and `floatp' can take any type of Lisp object as argument (the predicates would not be of much use otherwise); but the `zerop' predicate requires a number as its argument. See also `integer-or-marker-p' and `number-or-marker-p', in *Note Predicates on Markers::. - Function: floatp OBJECT This predicate tests whether its argument is a floating point number and returns `t' if so, `nil' otherwise. `floatp' does not exist in Emacs versions 18 and earlier. - Function: integerp OBJECT This predicate tests whether its argument is an integer, and returns `t' if so, `nil' otherwise. - Function: numberp OBJECT This predicate tests whether its argument is a number (either integer or floating point), and returns `t' if so, `nil' otherwise. - Function: wholenump OBJECT The `wholenump' predicate (whose name comes from the phrase "whole-number-p") tests to see whether its argument is a nonnegative integer, and returns `t' if so, `nil' otherwise. 0 is considered non-negative. `natnump' is an obsolete synonym for `wholenump'. - Function: zerop NUMBER This predicate tests whether its argument is zero, and returns `t' if so, `nil' otherwise. The argument must be a number. These two forms are equivalent: `(zerop x)' == `(= x 0)'. Comparison of Numbers ===================== To test numbers for numerical equality, you should normally use `=', not `eq'. There can be many distinct floating point number objects with the same numeric value. If you use `eq' to compare them, then you test whether two values are the same *object*. By contrast, `=' compares only the numeric values of the objects. At present, each integer value has a unique Lisp object in Emacs Lisp. Therefore, `eq' is equivalent to `=' where integers are concerned. It is sometimes convenient to use `eq' for comparing an unknown value with an integer, because `eq' does not report an error if the unknown value is not a number--it accepts arguments of any type. By contrast, `=' signals an error if the arguments are not numbers or markers. However, it is a good idea to use `=' if you can, even for comparing integers, just in case we change the representation of integers in a future Emacs version. Sometimes it is useful to compare numbers with `equal'; it treats two numbers as equal if they have the same data type (both integers, or both floating point) and the same value. By contrast, `=' can treat an integer and a floating point number as equal. There is another wrinkle: because floating point arithmetic is not exact, it is often a bad idea to check for equality of two floating point values. Usually it is better to test for approximate equality. Here's a function to do this: (defvar fuzz-factor 1.0e-6) (defun approx-equal (x y) (or (and (= x 0) (= y 0)) (< (/ (abs (- x y)) (max (abs x) (abs y))) fuzz-factor))) Common Lisp note: Comparing numbers in Common Lisp always requires `=' because Common Lisp implements multi-word integers, and two distinct integer objects can have the same numeric value. Emacs Lisp can have just one integer object for any given value because it has a limited range of integer values. - Function: = NUMBER-OR-MARKER1 NUMBER-OR-MARKER2 This function tests whether its arguments are numerically equal, and returns `t' if so, `nil' otherwise. - Function: /= NUMBER-OR-MARKER1 NUMBER-OR-MARKER2 This function tests whether its arguments are numerically equal, and returns `t' if they are not, and `nil' if they are. - Function: < NUMBER-OR-MARKER1 NUMBER-OR-MARKER2 This function tests whether its first argument is strictly less than its second argument. It returns `t' if so, `nil' otherwise. - Function: <= NUMBER-OR-MARKER1 NUMBER-OR-MARKER2 This function tests whether its first argument is less than or equal to its second argument. It returns `t' if so, `nil' otherwise. - Function: > NUMBER-OR-MARKER1 NUMBER-OR-MARKER2 This function tests whether its first argument is strictly greater than its second argument. It returns `t' if so, `nil' otherwise. - Function: >= NUMBER-OR-MARKER1 NUMBER-OR-MARKER2 This function tests whether its first argument is greater than or equal to its second argument. It returns `t' if so, `nil' otherwise. - Function: max NUMBER-OR-MARKER &rest NUMBERS-OR-MARKERS This function returns the largest of its arguments. (max 20) => 20 (max 1 2.5) => 2.5 (max 1 3 2.5) => 3 - Function: min NUMBER-OR-MARKER &rest NUMBERS-OR-MARKERS This function returns the smallest of its arguments. (min -4 1) => -4 - Function: abs NUMBER This function returns the absolute value of NUMBER. Numeric Conversions =================== To convert an integer to floating point, use the function `float'. - Function: float NUMBER This returns NUMBER converted to floating point. If NUMBER is already a floating point number, `float' returns it unchanged. There are four functions to convert floating point numbers to integers; they differ in how they round. These functions accept integer arguments also, and return such arguments unchanged. - Function: truncate NUMBER This returns NUMBER, converted to an integer by rounding towards zero. - Function: floor NUMBER &optional DIVISOR This returns NUMBER, converted to an integer by rounding downward (towards negative infinity). If DIVISOR is specified, NUMBER is divided by DIVISOR before the floor is taken; this uses the kind of division operation that corresponds to `mod', rounding downward. An `arith-error' results if DIVISOR is 0. - Function: ceiling NUMBER This returns NUMBER, converted to an integer by rounding upward (towards positive infinity). - Function: round NUMBER This returns NUMBER, converted to an integer by rounding towards the nearest integer. Rounding a value equidistant between two integers may choose the integer closer to zero, or it may prefer an even integer, depending on your machine. Arithmetic Operations ===================== Emacs Lisp provides the traditional four arithmetic operations: addition, subtraction, multiplication, and division. Remainder and modulus functions supplement the division functions. The functions to add or subtract 1 are provided because they are traditional in Lisp and commonly used. All of these functions except `%' return a floating point value if any argument is floating. It is important to note that in Emacs Lisp, arithmetic functions do not check for overflow. Thus `(1+ 134217727)' may evaluate to -134217728, depending on your hardware. - Function: 1+ NUMBER-OR-MARKER This function returns NUMBER-OR-MARKER plus 1. For example, (setq foo 4) => 4 (1+ foo) => 5 This function is not analogous to the C operator `++'--it does not increment a variable. It just computes a sum. Thus, if we continue, foo => 4 If you want to increment the variable, you must use `setq', like this: (setq foo (1+ foo)) => 5 - Function: 1- NUMBER-OR-MARKER This function returns NUMBER-OR-MARKER minus 1. - Function: + &rest NUMBERS-OR-MARKERS This function adds its arguments together. When given no arguments, `+' returns 0. (+) => 0 (+ 1) => 1 (+ 1 2 3 4) => 10 - Function: - &optional NUMBER-OR-MARKER &rest MORE-NUMBERS-OR-MARKERS The `-' function serves two purposes: negation and subtraction. When `-' has a single argument, the value is the negative of the argument. When there are multiple arguments, `-' subtracts each of the MORE-NUMBERS-OR-MARKERS from NUMBER-OR-MARKER, cumulatively. If there are no arguments, the result is 0. (- 10 1 2 3 4) => 0 (- 10) => -10 (-) => 0 - Function: * &rest NUMBERS-OR-MARKERS This function multiplies its arguments together, and returns the product. When given no arguments, `*' returns 1. (*) => 1 (* 1) => 1 (* 1 2 3 4) => 24 - Function: / DIVIDEND DIVISOR &rest DIVISORS This function divides DIVIDEND by DIVISOR and returns the quotient. If there are additional arguments DIVISORS, then it divides DIVIDEND by each divisor in turn. Each argument may be a number or a marker. If all the arguments are integers, then the result is an integer too. This means the result has to be rounded. On most machines, the result is rounded towards zero after each division, but some machines may round differently with negative arguments. This is because the Lisp function `/' is implemented using the C division operator, which also permits machine-dependent rounding. As a practical matter, all known machines round in the standard fashion. If you divide an integer by 0, an `arith-error' error is signaled. (*Note Errors::.) Floating point division by zero returns either infinity or a NaN if your machine supports IEEE floating point; otherwise, it signals an `arith-error' error. (/ 6 2) => 3 (/ 5 2) => 2 (/ 5.0 2) => 2.5 (/ 5 2.0) => 2.5 (/ 5.0 2.0) => 2.5 (/ 25 3 2) => 4 (/ -17 6) => -2 The result of `(/ -17 6)' could in principle be -3 on some machines. - Function: % DIVIDEND DIVISOR This function returns the integer remainder after division of DIVIDEND by DIVISOR. The arguments must be integers or markers. For negative arguments, the remainder is in principle machine-dependent since the quotient is; but in practice, all known machines behave alike. An `arith-error' results if DIVISOR is 0. (% 9 4) => 1 (% -9 4) => -1 (% 9 -4) => 1 (% -9 -4) => -1 For any two integers DIVIDEND and DIVISOR, (+ (% DIVIDEND DIVISOR) (* (/ DIVIDEND DIVISOR) DIVISOR)) always equals DIVIDEND. - Function: mod DIVIDEND DIVISOR This function returns the value of DIVIDEND modulo DIVISOR; in other words, the remainder after division of DIVIDEND by DIVISOR, but with the same sign as DIVISOR. The arguments must be numbers or markers. Unlike `%', `mod' returns a well-defined result for negative arguments. It also permits floating point arguments; it rounds the quotient downward (towards minus infinity) to an integer, and uses that quotient to compute the remainder. An `arith-error' results if DIVISOR is 0. (mod 9 4) => 1 (mod -9 4) => 3 (mod 9 -4) => -3 (mod -9 -4) => -1 (mod 5.5 2.5) => .5 For any two numbers DIVIDEND and DIVISOR, (+ (mod DIVIDEND DIVISOR) (* (floor DIVIDEND DIVISOR) DIVISOR)) always equals DIVIDEND, subject to rounding error if either argument is floating point. For `floor', see *Note Numeric Conversions::. Rounding Operations =================== The functions `ffloor', `fceiling', `fround', and `ftruncate' take a floating point argument and return a floating point result whose value is a nearby integer. `ffloor' returns the nearest integer below; `fceiling', the nearest integer above; `ftruncate', the nearest integer in the direction towards zero; `fround', the nearest integer. - Function: ffloor FLOAT This function rounds FLOAT to the next lower integral value, and returns that value as a floating point number. - Function: fceiling FLOAT This function rounds FLOAT to the next higher integral value, and returns that value as a floating point number. - Function: ftruncate FLOAT This function rounds FLOAT towards zero to an integral value, and returns that value as a floating point number. - Function: fround FLOAT This function rounds FLOAT to the nearest integral value, and returns that value as a floating point number. Bitwise Operations on Integers ============================== In a computer, an integer is represented as a binary number, a sequence of "bits" (digits which are either zero or one). A bitwise operation acts on the individual bits of such a sequence. For example, "shifting" moves the whole sequence left or right one or more places, reproducing the same pattern "moved over". The bitwise operations in Emacs Lisp apply only to integers. - Function: lsh INTEGER1 COUNT `lsh', which is an abbreviation for "logical shift", shifts the bits in INTEGER1 to the left COUNT places, or to the right if COUNT is negative, bringing zeros into the vacated bits. If COUNT is negative, `lsh' shifts zeros into the leftmost (most-significant) bit, producing a positive result even if INTEGER1 is negative. Contrast this with `ash', below. Here are two examples of `lsh', shifting a pattern of bits one place to the left. We show only the low-order eight bits of the binary pattern; the rest are all zero. (lsh 5 1) => 10 ;; Decimal 5 becomes decimal 10. 00000101 => 00001010 (lsh 7 1) => 14 ;; Decimal 7 becomes decimal 14. 00000111 => 00001110 As the examples illustrate, shifting the pattern of bits one place to the left produces a number that is twice the value of the previous number. Shifting a pattern of bits two places to the left produces results like this (with 8-bit binary numbers): (lsh 3 2) => 12 ;; Decimal 3 becomes decimal 12. 00000011 => 00001100 On the other hand, shifting one place to the right looks like this: (lsh 6 -1) => 3 ;; Decimal 6 becomes decimal 3. 00000110 => 00000011 (lsh 5 -1) => 2 ;; Decimal 5 becomes decimal 2. 00000101 => 00000010 As the example illustrates, shifting one place to the right divides the value of a positive integer by two, rounding downward. The function `lsh', like all Emacs Lisp arithmetic functions, does not check for overflow, so shifting left can discard significant bits and change the sign of the number. For example, left shifting 134,217,727 produces -2 on a 28-bit machine: (lsh 134217727 1) ; left shift => -2 In binary, in the 28-bit implementation, the argument looks like this: ;; Decimal 134,217,727 0111 1111 1111 1111 1111 1111 1111 which becomes the following when left shifted: ;; Decimal -2 1111 1111 1111 1111 1111 1111 1110 - Function: ash INTEGER1 COUNT `ash' ("arithmetic shift") shifts the bits in INTEGER1 to the left COUNT places, or to the right if COUNT is negative. `ash' gives the same results as `lsh' except when INTEGER1 and COUNT are both negative. In that case, `ash' puts ones in the empty bit positions on the left, while `lsh' puts zeros in those bit positions. Thus, with `ash', shifting the pattern of bits one place to the right looks like this: (ash -6 -1) => -3 ;; Decimal -6 becomes decimal -3. 1111 1111 1111 1111 1111 1111 1010 => 1111 1111 1111 1111 1111 1111 1101 In contrast, shifting the pattern of bits one place to the right with `lsh' looks like this: (lsh -6 -1) => 134217725 ;; Decimal -6 becomes decimal 134,217,725. 1111 1111 1111 1111 1111 1111 1010 => 0111 1111 1111 1111 1111 1111 1101 Here are other examples: ; 28-bit binary values (lsh 5 2) ; 5 = 0000 0000 0000 0000 0000 0000 0101 => 20 ; = 0000 0000 0000 0000 0000 0001 0100 (ash 5 2) => 20 (lsh -5 2) ; -5 = 1111 1111 1111 1111 1111 1111 1011 => -20 ; = 1111 1111 1111 1111 1111 1110 1100 (ash -5 2) => -20 (lsh 5 -2) ; 5 = 0000 0000 0000 0000 0000 0000 0101 => 1 ; = 0000 0000 0000 0000 0000 0000 0001 (ash 5 -2) => 1 (lsh -5 -2) ; -5 = 1111 1111 1111 1111 1111 1111 1011 => 4194302 ; = 0011 1111 1111 1111 1111 1111 1110 (ash -5 -2) ; -5 = 1111 1111 1111 1111 1111 1111 1011 => -2 ; = 1111 1111 1111 1111 1111 1111 1110 - Function: logand &rest INTS-OR-MARKERS This function returns the "logical and" of the arguments: the Nth bit is set in the result if, and only if, the Nth bit is set in all the arguments. ("Set" means that the value of the bit is 1 rather than 0.) For example, using 4-bit binary numbers, the "logical and" of 13 and 12 is 12: 1101 combined with 1100 produces 1100. In both the binary numbers, the leftmost two bits are set (i.e., they are 1's), so the leftmost two bits of the returned value are set. However, for the rightmost two bits, each is zero in at least one of the arguments, so the rightmost two bits of the returned value are 0's. Therefore, (logand 13 12) => 12 If `logand' is not passed any argument, it returns a value of -1. This number is an identity element for `logand' because its binary representation consists entirely of ones. If `logand' is passed just one argument, it returns that argument. ; 28-bit binary values (logand 14 13) ; 14 = 0000 0000 0000 0000 0000 0000 1110 ; 13 = 0000 0000 0000 0000 0000 0000 1101 => 12 ; 12 = 0000 0000 0000 0000 0000 0000 1100 (logand 14 13 4) ; 14 = 0000 0000 0000 0000 0000 0000 1110 ; 13 = 0000 0000 0000 0000 0000 0000 1101 ; 4 = 0000 0000 0000 0000 0000 0000 0100 => 4 ; 4 = 0000 0000 0000 0000 0000 0000 0100 (logand) => -1 ; -1 = 1111 1111 1111 1111 1111 1111 1111 - Function: logior &rest INTS-OR-MARKERS This function returns the "inclusive or" of its arguments: the Nth bit is set in the result if, and only if, the Nth bit is set in at least one of the arguments. If there are no arguments, the result is zero, which is an identity element for this operation. If `logior' is passed just one argument, it returns that argument. ; 28-bit binary values (logior 12 5) ; 12 = 0000 0000 0000 0000 0000 0000 1100 ; 5 = 0000 0000 0000 0000 0000 0000 0101 => 13 ; 13 = 0000 0000 0000 0000 0000 0000 1101 (logior 12 5 7) ; 12 = 0000 0000 0000 0000 0000 0000 1100 ; 5 = 0000 0000 0000 0000 0000 0000 0101 ; 7 = 0000 0000 0000 0000 0000 0000 0111 => 15 ; 15 = 0000 0000 0000 0000 0000 0000 1111 - Function: logxor &rest INTS-OR-MARKERS This function returns the "exclusive or" of its arguments: the Nth bit is set in the result if, and only if, the Nth bit is set in an odd number of the arguments. If there are no arguments, the result is 0, which is an identity element for this operation. If `logxor' is passed just one argument, it returns that argument. ; 28-bit binary values (logxor 12 5) ; 12 = 0000 0000 0000 0000 0000 0000 1100 ; 5 = 0000 0000 0000 0000 0000 0000 0101 => 9 ; 9 = 0000 0000 0000 0000 0000 0000 1001 (logxor 12 5 7) ; 12 = 0000 0000 0000 0000 0000 0000 1100 ; 5 = 0000 0000 0000 0000 0000 0000 0101 ; 7 = 0000 0000 0000 0000 0000 0000 0111 => 14 ; 14 = 0000 0000 0000 0000 0000 0000 1110 - Function: lognot INTEGER This function returns the logical complement of its argument: the Nth bit is one in the result if, and only if, the Nth bit is zero in INTEGER, and vice-versa. (lognot 5) => -6 ;; 5 = 0000 0000 0000 0000 0000 0000 0101 ;; becomes ;; -6 = 1111 1111 1111 1111 1111 1111 1010 Standard Mathematical Functions =============================== These mathematical functions allow integers as well as floating point numbers as arguments. - Function: sin ARG - Function: cos ARG - Function: tan ARG These are the ordinary trigonometric functions, with argument measured in radians. - Function: asin ARG The value of `(asin ARG)' is a number between -pi/2 and pi/2 (inclusive) whose sine is ARG; if, however, ARG is out of range (outside [-1, 1]), then the result is a NaN. - Function: acos ARG The value of `(acos ARG)' is a number between 0 and pi (inclusive) whose cosine is ARG; if, however, ARG is out of range (outside [-1, 1]), then the result is a NaN. - Function: atan ARG The value of `(atan ARG)' is a number between -pi/2 and pi/2 (exclusive) whose tangent is ARG. - Function: exp ARG This is the exponential function; it returns e to the power ARG. e is a fundamental mathematical constant also called the base of natural logarithms. - Function: log ARG &optional BASE This function returns the logarithm of ARG, with base BASE. If you don't specify BASE, the base e is used. If ARG is negative, the result is a NaN. - Function: log10 ARG This function returns the logarithm of ARG, with base 10. If ARG is negative, the result is a NaN. `(log10 X)' == `(log X 10)', at least approximately. - Function: expt X Y This function returns X raised to power Y. If both arguments are integers and Y is positive, the result is an integer; in this case, it is truncated to fit the range of possible integer values. - Function: sqrt ARG This returns the square root of ARG. If ARG is negative, the value is a NaN. Random Numbers ============== A deterministic computer program cannot generate true random numbers. For most purposes, "pseudo-random numbers" suffice. A series of pseudo-random numbers is generated in a deterministic fashion. The numbers are not truly random, but they have certain properties that mimic a random series. For example, all possible values occur equally often in a pseudo-random series. In Emacs, pseudo-random numbers are generated from a "seed" number. Starting from any given seed, the `random' function always generates the same sequence of numbers. Emacs always starts with the same seed value, so the sequence of values of `random' is actually the same in each Emacs run! For example, in one operating system, the first call to `(random)' after you start Emacs always returns -1457731, and the second one always returns -7692030. This repeatability is helpful for debugging. If you want truly unpredictable random numbers, execute `(random t)'. This chooses a new seed based on the current time of day and on Emacs's process ID number. - Function: random &optional LIMIT This function returns a pseudo-random integer. Repeated calls return a series of pseudo-random integers. If LIMIT is a positive integer, the value is chosen to be nonnegative and less than LIMIT. If LIMIT is `t', it means to choose a new seed based on the current time of day and on Emacs's process ID number. On some machines, any integer representable in Lisp may be the result of `random'. On other machines, the result can never be larger than a certain maximum or less than a certain (negative) minimum. Strings and Characters ********************** A string in Emacs Lisp is an array that contains an ordered sequence of characters. Strings are used as names of symbols, buffers, and files, to send messages to users, to hold text being copied between buffers, and for many other purposes. Because strings are so important, Emacs Lisp has many functions expressly for manipulating them. Emacs Lisp programs use strings more often than individual characters. *Note Strings of Events::, for special considerations for strings of keyboard character events. String and Character Basics =========================== Strings in Emacs Lisp are arrays that contain an ordered sequence of characters. Characters are represented in Emacs Lisp as integers; whether an integer is a character or not is determined only by how it is used. Thus, strings really contain integers. The length of a string (like any array) is fixed, and cannot be altered once the string exists. Strings in Lisp are *not* terminated by a distinguished character code. (By contrast, strings in C are terminated by a character with ASCII code 0.) Since strings are arrays, and therefore sequences as well, you can operate on them with the general array and sequence functions. (*Note Sequences Arrays Vectors::.) For example, you can access or change individual characters in a string using the functions `aref' and `aset' (*note Array Functions::.). There are two text representations for non-ASCII characters in Emacs strings (and in buffers): unibyte and multibyte (*note Text Representations::.). ASCII characters always occupy one byte in a string; in fact, there is no real difference between the two representation for a string which is all ASCII. For most Lisp programming, you don't need to be concerned with these two representations. Sometimes key sequences are represented as strings. When a string is a key sequence, string elements in the range 128 to 255 represent meta characters (which are extremely large integers) rather than character codes in the range 128 to 255. Strings cannot hold characters that have the hyper, super or alt modifiers; they can hold ASCII control characters, but no other control characters. They do not distinguish case in ASCII control characters. If you want to store such characters in a sequence, such as a key sequence, you must use a vector instead of a string. *Note Character Type::, for more information about representation of meta and other modifiers for keyboard input characters. Strings are useful for holding regular expressions. You can also match regular expressions against strings (*note Regexp Search::.). The functions `match-string' (*note Simple Match Data::.) and `replace-match' (*note Replacing Match::.) are useful for decomposing and modifying strings based on regular expression matching. Like a buffer, a string can contain text properties for the characters in it, as well as the characters themselves. *Note Text Properties::. All the Lisp primitives that copy text from strings to buffers or other strings also copy the properties of the characters being copied. *Note Text::, for information about functions that display strings or copy them into buffers. *Note Character Type::, and *Note String Type::, for information about the syntax of characters and strings. *Note Non-ASCII Characters::, for functions to convert between text representations and encode and decode character codes. The Predicates for Strings ========================== For more information about general sequence and array predicates, see *Note Sequences Arrays Vectors::, and *Note Arrays::. - Function: stringp OBJECT This function returns `t' if OBJECT is a string, `nil' otherwise. - Function: char-or-string-p OBJECT This function returns `t' if OBJECT is a string or a character (i.e., an integer), `nil' otherwise. Creating Strings ================ The following functions create strings, either from scratch, or by putting strings together, or by taking them apart. - Function: make-string COUNT CHARACTER This function returns a string made up of COUNT repetitions of CHARACTER. If COUNT is negative, an error is signaled. (make-string 5 ?x) => "xxxxx" (make-string 0 ?x) => "" Other functions to compare with this one include `char-to-string' (*note String Conversion::.), `make-vector' (*note Vectors::.), and `make-list' (*note Building Lists::.). - Function: string &rest CHARACTERS This returns a string containing the characters CHARACTERS. (string ?a ?b ?c) => "abc" - Function: substring STRING START &optional END This function returns a new string which consists of those characters from STRING in the range from (and including) the character at the index START up to (but excluding) the character at the index END. The first character is at index zero. (substring "abcdefg" 0 3) => "abc" Here the index for `a' is 0, the index for `b' is 1, and the index for `c' is 2. Thus, three letters, `abc', are copied from the string `"abcdefg"'. The index 3 marks the character position up to which the substring is copied. The character whose index is 3 is actually the fourth character in the string. A negative number counts from the end of the string, so that -1 signifies the index of the last character of the string. For example: (substring "abcdefg" -3 -1) => "ef" In this example, the index for `e' is -3, the index for `f' is -2, and the index for `g' is -1. Therefore, `e' and `f' are included, and `g' is excluded. When `nil' is used as an index, it stands for the length of the string. Thus, (substring "abcdefg" -3 nil) => "efg" Omitting the argument END is equivalent to specifying `nil'. It follows that `(substring STRING 0)' returns a copy of all of STRING. (substring "abcdefg" 0) => "abcdefg" But we recommend `copy-sequence' for this purpose (*note Sequence Functions::.). If the characters copied from STRING have text properties, the properties are copied into the new string also. *Note Text Properties::. `substring' also allows vectors for the first argument. For example: (substring [a b (c) "d"] 1 3) => [b (c)] A `wrong-type-argument' error is signaled if either START or END is not an integer or `nil'. An `args-out-of-range' error is signaled if START indicates a character following END, or if either integer is out of range for STRING. Contrast this function with `buffer-substring' (*note Buffer Contents::.), which returns a string containing a portion of the text in the current buffer. The beginning of a string is at index 0, but the beginning of a buffer is at index 1. - Function: concat &rest SEQUENCES This function returns a new string consisting of the characters in the arguments passed to it (along with their text properties, if any). The arguments may be strings, lists of numbers, or vectors of numbers; they are not themselves changed. If `concat' receives no arguments, it returns an empty string. (concat "abc" "-def") => "abc-def" (concat "abc" (list 120 121) [122]) => "abcxyz" ;; `nil' is an empty sequence. (concat "abc" nil "-def") => "abc-def" (concat "The " "quick brown " "fox.") => "The quick brown fox." (concat) => "" The `concat' function always constructs a new string that is not `eq' to any existing string. When an argument is an integer (not a sequence of integers), it is converted to a string of digits making up the decimal printed representation of the integer. *Don't use this feature; we plan to eliminate it. If you already use this feature, change your programs now!* The proper way to convert an integer to a decimal number in this way is with `format' (*note Formatting Strings::.) or `number-to-string' (*note String Conversion::.). (concat 137) => "137" (concat 54 321) => "54321" For information about other concatenation functions, see the description of `mapconcat' in *Note Mapping Functions::, `vconcat' in *Note Vectors::, and `append' in *Note Building Lists::. - Function: split-string STRING SEPARATORS Split STRING into substrings in between matches for the regular expression SEPARATORS. Each match for SEPARATORS defines a splitting point; the substrings between the splitting points are made into a list, which is the value. If SEPARATORS is `nil' (or omitted), the default is `"[ \f\t\n\r\v]+"'. For example, (split-string "Soup is good food" "o") => ("S" "up is g" "" "d f" "" "d") (split-string "Soup is good food" "o+") => ("S" "up is g" "d f" "d") When there is a match adjacent to the beginning or end of the string, this does not cause a null string to appear at the beginning or end of the list: (split-string "out to moo" "o+") => ("ut t" " m") Empty matches do count, when not adjacent to another match: (split-string "Soup is good food" "o*") =>("S" "u" "p" " " "i" "s" " " "g" "d" " " "f" "d") (split-string "Nice doggy!" "") =>("N" "i" "c" "e" " " "d" "o" "g" "g" "y" "!") Modifying Strings ================= The most basic way to alter the contents of an existing string is with `aset' (*note Array Functions::.). `(aset STRING IDX CHAR)' stores CHAR into STRING at index IDX. Each character occupies one or more bytes, and if CHAR needs a different number of bytes from the character already present at that index, `aset' signals an error. A more powerful function is `store-substring': - Function: store-substring STRING IDX OBJ This function alters part of the contents of the string STRING, by storing OBJ starting at index IDX. The argument OBJ may be either a character or a (smaller) string. Since it is impossible to change the length of an existing string, it is an error if OBJ doesn't fit within STRING's actual length, of if any new character requires a different number of bytes from the character currently present at that point in STRING. Comparison of Characters and Strings ==================================== - Function: char-equal CHARACTER1 CHARACTER2 This function returns `t' if the arguments represent the same character, `nil' otherwise. This function ignores differences in case if `case-fold-search' is non-`nil'. (char-equal ?x ?x) => t (let ((case-fold-search nil)) (char-equal ?x ?X)) => nil - Function: string= STRING1 STRING2 This function returns `t' if the characters of the two strings match exactly; case is significant. (string= "abc" "abc") => t (string= "abc" "ABC") => nil (string= "ab" "ABC") => nil The function `string=' ignores the text properties of the two strings. When `equal' (*note Equality Predicates::.) compares two strings, it uses `string='. If the strings contain non-ASCII characters, and one is unibyte while the other is multibyte, then they cannot be equal. *Note Text Representations::. - Function: string-equal STRING1 STRING2 `string-equal' is another name for `string='. - Function: string< STRING1 STRING2 This function compares two strings a character at a time. First it scans both the strings at once to find the first pair of corresponding characters that do not match. If the lesser character of those two is the character from STRING1, then STRING1 is less, and this function returns `t'. If the lesser character is the one from STRING2, then STRING1 is greater, and this function returns `nil'. If the two strings match entirely, the value is `nil'. Pairs of characters are compared according to their character codes. Keep in mind that lower case letters have higher numeric values in the ASCII character set than their upper case counterparts; digits and many punctuation characters have a lower numeric value than upper case letters. An ASCII character is less than any non-ASCII character; a unibyte non-ASCII character is always less than any multibyte non-ASCII character (*note Text Representations::.). (string< "abc" "abd") => t (string< "abd" "abc") => nil (string< "123" "abc") => t When the strings have different lengths, and they match up to the length of STRING1, then the result is `t'. If they match up to the length of STRING2, the result is `nil'. A string of no characters is less than any other string. (string< "" "abc") => t (string< "ab" "abc") => t (string< "abc" "") => nil (string< "abc" "ab") => nil (string< "" "") => nil - Function: string-lessp STRING1 STRING2 `string-lessp' is another name for `string<'. - Function: compare-strings STRING1 START1 END1 STRING2 START2 END2 &optional IGNORE-CASE This function compares a specified part of STRING1 with a specified part of STRING2. The specified part of STRING1 runs from index START1 up to index END1 (default, the end of the string). The specified part of STRING2 runs from index START2 up to index END2 (default, the end of the string). The strings are both converted to multibyte for the comparison (*note Text Representations::.) so that a unibyte string can be equal to a multibyte string. If IGNORE-CASE is non-`nil', then case is ignored, so that upper case letters can be equal to lower case letters. If the specified portions of the two strings match, the value is `t'. Otherwise, the value is an integer which indicates how many leading characters agree, and which string is less. Its absolute value is one plus the number of characters that agree at the beginning of the two strings. The sign is negative if STRING1 (or its specified portion) is less. - Function: assoc-ignore-case KEY ALIST This function works like `assoc', except that KEY must be a string, and comparison is done using `compare-strings'. Case differences are ignored in this comparison. - Function: assoc-ignore-representation KEY ALIST This function works like `assoc', except that KEY must be a string, and comparison is done using `compare-strings'. Case differences are significant. See also `compare-buffer-substrings' in *Note Comparing Text::, for a way to compare text in buffers. The function `string-match', which matches a regular expression against a string, can be used for a kind of string comparison; see *Note Regexp Search::. Conversion of Characters and Strings ==================================== This section describes functions for conversions between characters, strings and integers. `format' and `prin1-to-string' (*note Output Functions::.) can also convert Lisp objects into strings. `read-from-string' (*note Input Functions::.) can "convert" a string representation of a Lisp object into an object. The functions `string-make-multibyte' and `string-make-unibyte' convert the text representation of a string (*note Converting Representations::.). *Note Documentation::, for functions that produce textual descriptions of text characters and general input events (`single-key-description' and `text-char-description'). These functions are used primarily for making help messages. - Function: char-to-string CHARACTER This function returns a new string containing one character, CHARACTER. This function is semi-obsolete because the function `string' is more general. *Note Creating Strings::. - Function: string-to-char STRING This function returns the first character in STRING. If the string is empty, the function returns 0. The value is also 0 when the first character of STRING is the null character, ASCII code 0. (string-to-char "ABC") => 65 (string-to-char "xyz") => 120 (string-to-char "") => 0 (string-to-char "\000") => 0 This function may be eliminated in the future if it does not seem useful enough to retain. - Function: number-to-string NUMBER This function returns a string consisting of the printed representation of NUMBER, which may be an integer or a floating point number. The value starts with a sign if the argument is negative. (number-to-string 256) => "256" (number-to-string -23) => "-23" (number-to-string -23.5) => "-23.5" `int-to-string' is a semi-obsolete alias for this function. See also the function `format' in *Note Formatting Strings::. - Function: string-to-number STRING &optional BASE This function returns the numeric value of the characters in STRING. If BASE is non-`nil', integers are converted in that base. If BASE is `nil', then base ten is used. Floating point conversion always uses base ten; we have not implemented other radices for floating point numbers, because that would be much more work and does not seem useful. The parsing skips spaces and tabs at the beginning of STRING, then reads as much of STRING as it can interpret as a number. (On some systems it ignores other whitespace at the beginning, not just spaces and tabs.) If the first character after the ignored whitespace is not a digit or a plus or minus sign, this function returns 0. (string-to-number "256") => 256 (string-to-number "25 is a perfect square.") => 25 (string-to-number "X256") => 0 (string-to-number "-4.5") => -4.5 `string-to-int' is an obsolete alias for this function. Here are some other functions that can convert to or from a string: `concat' `concat' can convert a vector or a list into a string. *Note Creating Strings::. `vconcat' `vconcat' can convert a string into a vector. *Note Vector Functions::. `append' `append' can convert a string into a list. *Note Building Lists::. Formatting Strings ================== "Formatting" means constructing a string by substitution of computed values at various places in a constant string. This string controls how the other values are printed as well as where they appear; it is called a "format string". Formatting is often useful for computing messages to be displayed. In fact, the functions `message' and `error' provide the same formatting feature described here; they differ from `format' only in how they use the result of formatting. - Function: format STRING &rest OBJECTS This function returns a new string that is made by copying STRING and then replacing any format specification in the copy with encodings of the corresponding OBJECTS. The arguments OBJECTS are the computed values to be formatted. A format specification is a sequence of characters beginning with a `%'. Thus, if there is a `%d' in STRING, the `format' function replaces it with the printed representation of one of the values to be formatted (one of the arguments OBJECTS). For example: (format "The value of fill-column is %d." fill-column) => "The value of fill-column is 72." If STRING contains more than one format specification, the format specifications correspond with successive values from OBJECTS. Thus, the first format specification in STRING uses the first such value, the second format specification uses the second such value, and so on. Any extra format specifications (those for which there are no corresponding values) cause unpredictable behavior. Any extra values to be formatted are ignored. Certain format specifications require values of particular types. If you supply a value that doesn't fit the requirements, an error is signaled. Here is a table of valid format specifications: `%s' Replace the specification with the printed representation of the object, made without quoting (that is, using `princ', not `prin1'--*note Output Functions::.). Thus, strings are represented by their contents alone, with no `"' characters, and symbols appear without `\' characters. If there is no corresponding object, the empty string is used. `%S' Replace the specification with the printed representation of the object, made with quoting (that is, using `prin1'--*note Output Functions::.). Thus, strings are enclosed in `"' characters, and `\' characters appear where necessary before special characters. If there is no corresponding object, the empty string is used. `%o' Replace the specification with the base-eight representation of an integer. `%d' Replace the specification with the base-ten representation of an integer. `%x' Replace the specification with the base-sixteen representation of an integer. `%c' Replace the specification with the character which is the value given. `%e' Replace the specification with the exponential notation for a floating point number. `%f' Replace the specification with the decimal-point notation for a floating point number. `%g' Replace the specification with notation for a floating point number, using either exponential notation or decimal-point notation, whichever is shorter. `%%' A single `%' is placed in the string. This format specification is unusual in that it does not use a value. For example, `(format "%% %d" 30)' returns `"% 30"'. Any other format character results in an `Invalid format operation' error. Here are several examples: (format "The name of this buffer is %s." (buffer-name)) => "The name of this buffer is strings.texi." (format "The buffer object prints as %s." (current-buffer)) => "The buffer object prints as strings.texi." (format "The octal value of %d is %o, and the hex value is %x." 18 18 18) => "The octal value of 18 is 22, and the hex value is 12." All the specification characters allow an optional numeric prefix between the `%' and the character. The optional numeric prefix defines the minimum width for the object. If the printed representation of the object contains fewer characters than this, then it is padded. The padding is on the left if the prefix is positive (or starts with zero) and on the right if the prefix is negative. The padding character is normally a space, but if the numeric prefix starts with a zero, zeros are used for padding. Here are some examples of padding: (format "%06d is padded on the left with zeros" 123) => "000123 is padded on the left with zeros" (format "%-6d is padded on the right" 123) => "123 is padded on the right" `format' never truncates an object's printed representation, no matter what width you specify. Thus, you can use a numeric prefix to specify a minimum spacing between columns with no risk of losing information. In the following three examples, `%7s' specifies a minimum width of 7. In the first case, the string inserted in place of `%7s' has only 3 letters, so 4 blank spaces are inserted for padding. In the second case, the string `"specification"' is 13 letters wide but is not truncated. In the third case, the padding is on the right. (format "The word `%7s' actually has %d letters in it." "foo" (length "foo")) => "The word ` foo' actually has 3 letters in it." (format "The word `%7s' actually has %d letters in it." "specification" (length "specification")) => "The word `specification' actually has 13 letters in it." (format "The word `%-7s' actually has %d letters in it." "foo" (length "foo")) => "The word `foo ' actually has 3 letters in it." Case Conversion in Lisp ======================= The character case functions change the case of single characters or of the contents of strings. The functions normally convert only alphabetic characters (the letters `A' through `Z' and `a' through `z', as well as non-ASCII letters); other characters are not altered. (You can specify a different case conversion mapping by specifying a case table--*note Case Tables::..) These functions do not modify the strings that are passed to them as arguments. The examples below use the characters `X' and `x' which have ASCII codes 88 and 120 respectively. - Function: downcase STRING-OR-CHAR This function converts a character or a string to lower case. When the argument to `downcase' is a string, the function creates and returns a new string in which each letter in the argument that is upper case is converted to lower case. When the argument to `downcase' is a character, `downcase' returns the corresponding lower case character. This value is an integer. If the original character is lower case, or is not a letter, then the value equals the original character. (downcase "The cat in the hat") => "the cat in the hat" (downcase ?X) => 120 - Function: upcase STRING-OR-CHAR This function converts a character or a string to upper case. When the argument to `upcase' is a string, the function creates and returns a new string in which each letter in the argument that is lower case is converted to upper case. When the argument to `upcase' is a character, `upcase' returns the corresponding upper case character. This value is an integer. If the original character is upper case, or is not a letter, then the value equals the original character. (upcase "The cat in the hat") => "THE CAT IN THE HAT" (upcase ?x) => 88 - Function: capitalize STRING-OR-CHAR This function capitalizes strings or characters. If STRING-OR-CHAR is a string, the function creates and returns a new string, whose contents are a copy of STRING-OR-CHAR in which each word has been capitalized. This means that the first character of each word is converted to upper case, and the rest are converted to lower case. The definition of a word is any sequence of consecutive characters that are assigned to the word constituent syntax class in the current syntax table (*Note Syntax Class Table::). When the argument to `capitalize' is a character, `capitalize' has the same result as `upcase'. (capitalize "The cat in the hat") => "The Cat In The Hat" (capitalize "THE 77TH-HATTED CAT") => "The 77th-Hatted Cat" (capitalize ?x) => 88 - Function: upcase-initials STRING This function capitalizes the initials of the words in STRING. without altering any letters other than the initials. It returns a new string whose contents are a copy of STRING, in which each word has been converted to upper case. The definition of a word is any sequence of consecutive characters that are assigned to the word constituent syntax class in the current syntax table (*Note Syntax Class Table::). (upcase-initials "The CAT in the hAt") => "The CAT In The HAt" *Note Text Comparison::, for functions that compare strings; some of them ignore case differences, or can optionally ignore case differences. The Case Table ============== You can customize case conversion by installing a special "case table". A case table specifies the mapping between upper case and lower case letters. It affects both the case conversion functions for Lisp objects (see the previous section) and those that apply to text in the buffer (*note Case Changes::.). Each buffer has a case table; there is also a standard case table which is used to initialize the case table of new buffers. A case table is a char-table (*note Char-Tables::.) whose subtype is `case-table'. This char-table maps each character into the corresponding lower case character. It has three extra slots, which hold related tables: UPCASE The upcase table maps each character into the corresponding upper case character. CANONICALIZE The canonicalize table maps all of a set of case-related characters into a particular member of that set. EQUIVALENCES The equivalences table maps each one of a set of case-related characters into the next character in that set. In simple cases, all you need to specify is the mapping to lower-case; the three related tables will be calculated automatically from that one. For some languages, upper and lower case letters are not in one-to-one correspondence. There may be two different lower case letters with the same upper case equivalent. In these cases, you need to specify the maps for both lower case and upper case. The extra table CANONICALIZE maps each character to a canonical equivalent; any two characters that are related by case-conversion have the same canonical equivalent character. For example, since `a' and `A' are related by case-conversion, they should have the same canonical equivalent character (which should be either `a' for both of them, or `A' for both of them). The extra table EQUIVALENCES is a map that cyclicly permutes each equivalence class (of characters with the same canonical equivalent). (For ordinary ASCII, this would map `a' into `A' and `A' into `a', and likewise for each set of equivalent characters.) When you construct a case table, you can provide `nil' for CANONICALIZE; then Emacs fills in this slot from the lower case and upper case mappings. You can also provide `nil' for EQUIVALENCES; then Emacs fills in this slot from CANONICALIZE. In a case table that is actually in use, those components are non-`nil'. Do not try to specify EQUIVALENCES without also specifying CANONICALIZE. Here are the functions for working with case tables: - Function: case-table-p OBJECT This predicate returns non-`nil' if OBJECT is a valid case table. - Function: set-standard-case-table TABLE This function makes TABLE the standard case table, so that it will be used in any buffers created subsequently. - Function: standard-case-table This returns the standard case table. - Function: current-case-table This function returns the current buffer's case table. - Function: set-case-table TABLE This sets the current buffer's case table to TABLE. The following three functions are convenient subroutines for packages that define non-ASCII character sets. They modify the specified case table CASE-TABLE; they also modify the standard syntax table. *Note Syntax Tables::. Normally you would use these functions to change the standard case table. - Function: set-case-syntax-pair UC LC CASE-TABLE This function specifies a pair of corresponding letters, one upper case and one lower case. - Function: set-case-syntax-delims L R CASE-TABLE This function makes characters L and R a matching pair of case-invariant delimiters. - Function: set-case-syntax CHAR SYNTAX CASE-TABLE This function makes CHAR case-invariant, with syntax SYNTAX. - Command: describe-buffer-case-table This command displays a description of the contents of the current buffer's case table. Lists ***** A "list" represents a sequence of zero or more elements (which may be any Lisp objects). The important difference between lists and vectors is that two or more lists can share part of their structure; in addition, you can insert or delete elements in a list without copying the whole list. Lists and Cons Cells ==================== Lists in Lisp are not a primitive data type; they are built up from "cons cells". A cons cell is a data object that represents an ordered pair. It holds, or "points to," two Lisp objects, one labeled as the CAR, and the other labeled as the CDR. These names are traditional; see *Note Cons Cell Type::. CDR is pronounced "could-er." A list is a series of cons cells chained together, one cons cell per element of the list. By convention, the CARs of the cons cells are the elements of the list, and the CDRs are used to chain the list: the CDR of each cons cell is the following cons cell. The CDR of the last cons cell is `nil'. This asymmetry between the CAR and the CDR is entirely a matter of convention; at the level of cons cells, the CAR and CDR slots have the same characteristics. Because most cons cells are used as part of lists, the phrase "list structure" has come to mean any structure made out of cons cells. The symbol `nil' is considered a list as well as a symbol; it is the list with no elements. For convenience, the symbol `nil' is considered to have `nil' as its CDR (and also as its CAR). The CDR of any nonempty list L is a list containing all the elements of L except the first. Lists as Linked Pairs of Boxes ============================== A cons cell can be illustrated as a pair of boxes. The first box represents the CAR and the second box represents the CDR. Here is an illustration of the two-element list, `(tulip lily)', made from two cons cells: --------------- --------------- | car | cdr | | car | cdr | | tulip | o---------->| lily | nil | | | | | | | --------------- --------------- Each pair of boxes represents a cons cell. Each box "refers to", "points to" or "contains" a Lisp object. (These terms are synonymous.) The first box, which describes the CAR of the first cons cell, contains the symbol `tulip'. The arrow from the CDR box of the first cons cell to the second cons cell indicates that the CDR of the first cons cell is the second cons cell. The same list can be illustrated in a different sort of box notation like this: --- --- --- --- | | |--> | | |--> nil --- --- --- --- | | | | --> tulip --> lily Here is a more complex illustration, showing the three-element list, `((pine needles) oak maple)', the first element of which is a two-element list: --- --- --- --- --- --- | | |--> | | |--> | | |--> nil --- --- --- --- --- --- | | | | | | | --> oak --> maple | | --- --- --- --- --> | | |--> | | |--> nil --- --- --- --- | | | | --> pine --> needles The same list represented in the first box notation looks like this: -------------- -------------- -------------- | car | cdr | | car | cdr | | car | cdr | | o | o------->| oak | o------->| maple | nil | | | | | | | | | | | -- | --------- -------------- -------------- | | | -------------- ---------------- | | car | cdr | | car | cdr | ------>| pine | o------->| needles | nil | | | | | | | -------------- ---------------- *Note Cons Cell Type::, for the read and print syntax of cons cells and lists, and for more "box and arrow" illustrations of lists. Predicates on Lists =================== The following predicates test whether a Lisp object is an atom, is a cons cell or is a list, or whether it is the distinguished object `nil'. (Many of these predicates can be defined in terms of the others, but they are used so often that it is worth having all of them.) - Function: consp OBJECT This function returns `t' if OBJECT is a cons cell, `nil' otherwise. `nil' is not a cons cell, although it *is* a list. - Function: atom OBJECT This function returns `t' if OBJECT is an atom, `nil' otherwise. All objects except cons cells are atoms. The symbol `nil' is an atom and is also a list; it is the only Lisp object that is both. (atom OBJECT) == (not (consp OBJECT)) - Function: listp OBJECT This function returns `t' if OBJECT is a cons cell or `nil'. Otherwise, it returns `nil'. (listp '(1)) => t (listp '()) => t - Function: nlistp OBJECT This function is the opposite of `listp': it returns `t' if OBJECT is not a list. Otherwise, it returns `nil'. (listp OBJECT) == (not (nlistp OBJECT)) - Function: null OBJECT This function returns `t' if OBJECT is `nil', and returns `nil' otherwise. This function is identical to `not', but as a matter of clarity we use `null' when OBJECT is considered a list and `not' when it is considered a truth value (see `not' in *Note Combining Conditions::). (null '(1)) => nil (null '()) => t Accessing Elements of Lists =========================== - Function: car CONS-CELL This function returns the value pointed to by the first pointer of the cons cell CONS-CELL. Expressed another way, this function returns the CAR of CONS-CELL. As a special case, if CONS-CELL is `nil', then `car' is defined to return `nil'; therefore, any list is a valid argument for `car'. An error is signaled if the argument is not a cons cell or `nil'. (car '(a b c)) => a (car '()) => nil - Function: cdr CONS-CELL This function returns the value pointed to by the second pointer of the cons cell CONS-CELL. Expressed another way, this function returns the CDR of CONS-CELL. As a special case, if CONS-CELL is `nil', then `cdr' is defined to return `nil'; therefore, any list is a valid argument for `cdr'. An error is signaled if the argument is not a cons cell or `nil'. (cdr '(a b c)) => (b c) (cdr '()) => nil - Function: car-safe OBJECT This function lets you take the CAR of a cons cell while avoiding errors for other data types. It returns the CAR of OBJECT if OBJECT is a cons cell, `nil' otherwise. This is in contrast to `car', which signals an error if OBJECT is not a list. (car-safe OBJECT) == (let ((x OBJECT)) (if (consp x) (car x) nil)) - Function: cdr-safe OBJECT This function lets you take the CDR of a cons cell while avoiding errors for other data types. It returns the CDR of OBJECT if OBJECT is a cons cell, `nil' otherwise. This is in contrast to `cdr', which signals an error if OBJECT is not a list. (cdr-safe OBJECT) == (let ((x OBJECT)) (if (consp x) (cdr x) nil)) - Function: nth N LIST This function returns the Nth element of LIST. Elements are numbered starting with zero, so the CAR of LIST is element number zero. If the length of LIST is N or less, the value is `nil'. If N is negative, `nth' returns the first element of LIST. (nth 2 '(1 2 3 4)) => 3 (nth 10 '(1 2 3 4)) => nil (nth -3 '(1 2 3 4)) => 1 (nth n x) == (car (nthcdr n x)) The function `elt' is similar, but applies to any kind of sequence. For historical reasons, it takes its arguments in the opposite order. *Note Sequence Functions::. - Function: nthcdr N LIST This function returns the Nth CDR of LIST. In other words, it skips past the first N links of LIST and returns what follows. If N is zero or negative, `nthcdr' returns all of LIST. If the length of LIST is N or less, `nthcdr' returns `nil'. (nthcdr 1 '(1 2 3 4)) => (2 3 4) (nthcdr 10 '(1 2 3 4)) => nil (nthcdr -3 '(1 2 3 4)) => (1 2 3 4) - Function: safe-length LIST This function returns the length of LIST, with no risk of either an error or an infinite loop. If LIST is not really a list, `safe-length' returns 0. If LIST is circular, it returns a finite value which is at least the number of distinct elements. The most common way to compute the length of a list, when you are not worried that it may be circular, is with `length'. *Note Sequence Functions::. - Function: caar CONS-CELL This is the same as `(car (car CONS-CELL))'. - Function: cadr CONS-CELL This is the same as `(car (cdr CONS-CELL))' or `(nth 1 CONS-CELL)'. - Function: cdar CONS-CELL This is the same as `(cdr (car CONS-CELL))'. - Function: cddr CONS-CELL This is the same as `(cdr (cdr CONS-CELL))' or `(nthcdr 2 CONS-CELL)'. Building Cons Cells and Lists ============================= Many functions build lists, as lists reside at the very heart of Lisp. `cons' is the fundamental list-building function; however, it is interesting to note that `list' is used more times in the source code for Emacs than `cons'. - Function: cons OBJECT1 OBJECT2 This function is the fundamental function used to build new list structure. It creates a new cons cell, making OBJECT1 the CAR, and OBJECT2 the CDR. It then returns the new cons cell. The arguments OBJECT1 and OBJECT2 may be any Lisp objects, but most often OBJECT2 is a list. (cons 1 '(2)) => (1 2) (cons 1 '()) => (1) (cons 1 2) => (1 . 2) `cons' is often used to add a single element to the front of a list. This is called "consing the element onto the list". For example: (setq list (cons newelt list)) Note that there is no conflict between the variable named `list' used in this example and the function named `list' described below; any symbol can serve both purposes. - Function: list &rest OBJECTS This function creates a list with OBJECTS as its elements. The resulting list is always `nil'-terminated. If no OBJECTS are given, the empty list is returned. (list 1 2 3 4 5) => (1 2 3 4 5) (list 1 2 '(3 4 5) 'foo) => (1 2 (3 4 5) foo) (list) => nil - Function: make-list LENGTH OBJECT This function creates a list of length LENGTH, in which all the elements have the identical value OBJECT. Compare `make-list' with `make-string' (*note Creating Strings::.). (make-list 3 'pigs) => (pigs pigs pigs) (make-list 0 'pigs) => nil - Function: append &rest SEQUENCES This function returns a list containing all the elements of SEQUENCES. The SEQUENCES may be lists, vectors, bool-vectors, or strings, but the last one should usually be a list. All arguments except the last one are copied, so none of the arguments is altered. (See `nconc' in *Note Rearrangement::, for a way to join lists with no copying.) More generally, the final argument to `append' may be any Lisp object. The final argument is not copied or converted; it becomes the CDR of the last cons cell in the new list. If the final argument is itself a list, then its elements become in effect elements of the result list. If the final element is not a list, the result is a "dotted list" since its final CDR is not `nil' as required in a true list. The `append' function also allows integers as arguments. It converts them to strings of digits, making up the decimal print representation of the integer, and then uses the strings instead of the original integers. *Don't use this feature; we plan to eliminate it. If you already use this feature, change your programs now!* The proper way to convert an integer to a decimal number in this way is with `format' (*note Formatting Strings::.) or `number-to-string' (*note String Conversion::.). Here is an example of using `append': (setq trees '(pine oak)) => (pine oak) (setq more-trees (append '(maple birch) trees)) => (maple birch pine oak) trees => (pine oak) more-trees => (maple birch pine oak) (eq trees (cdr (cdr more-trees))) => t You can see how `append' works by looking at a box diagram. The variable `trees' is set to the list `(pine oak)' and then the variable `more-trees' is set to the list `(maple birch pine oak)'. However, the variable `trees' continues to refer to the original list: more-trees trees | | | --- --- --- --- -> --- --- --- --- --> | | |--> | | |--> | | |--> | | |--> nil --- --- --- --- --- --- --- --- | | | | | | | | --> maple -->birch --> pine --> oak An empty sequence contributes nothing to the value returned by `append'. As a consequence of this, a final `nil' argument forces a copy of the previous argument: trees => (pine oak) (setq wood (append trees nil)) => (pine oak) wood => (pine oak) (eq wood trees) => nil This once was the usual way to copy a list, before the function `copy-sequence' was invented. *Note Sequences Arrays Vectors::. Here we show the use of vectors and strings as arguments to `append': (append [a b] "cd" nil) => (a b 99 100) With the help of `apply' (*note Calling Functions::.), we can append all the lists in a list of lists: (apply 'append '((a b c) nil (x y z) nil)) => (a b c x y z) If no SEQUENCES are given, `nil' is returned: (append) => nil Here are some examples where the final argument is not a list: (append '(x y) 'z) => (x y . z) (append '(x y) [z]) => (x y . [z]) The second example shows that when the final argument is a sequence but not a list, the sequence's elements do not become elements of the resulting list. Instead, the sequence becomes the final CDR, like any other non-list final argument. - Function: reverse LIST This function creates a new list whose elements are the elements of LIST, but in reverse order. The original argument LIST is *not* altered. (setq x '(1 2 3 4)) => (1 2 3 4) (reverse x) => (4 3 2 1) x => (1 2 3 4) Modifying Existing List Structure ================================= You can modify the CAR and CDR contents of a cons cell with the primitives `setcar' and `setcdr'. We call these "destructive" operations because they change existing list structure. Common Lisp note: Common Lisp uses functions `rplaca' and `rplacd' to alter list structure; they change structure the same way as `setcar' and `setcdr', but the Common Lisp functions return the cons cell while `setcar' and `setcdr' return the new CAR or CDR. Altering List Elements with `setcar' ------------------------------------ Changing the CAR of a cons cell is done with `setcar'. When used on a list, `setcar' replaces one element of a list with a different element. - Function: setcar CONS OBJECT This function stores OBJECT as the new CAR of CONS, replacing its previous CAR. In other words, it changes the CAR slot of CONS to point to OBJECT. It returns the value OBJECT. For example: (setq x '(1 2)) => (1 2) (setcar x 4) => 4 x => (4 2) When a cons cell is part of the shared structure of several lists, storing a new CAR into the cons changes one element of each of these lists. Here is an example: ;; Create two lists that are partly shared. (setq x1 '(a b c)) => (a b c) (setq x2 (cons 'z (cdr x1))) => (z b c) ;; Replace the CAR of a shared link. (setcar (cdr x1) 'foo) => foo x1 ; Both lists are changed. => (a foo c) x2 => (z foo c) ;; Replace the CAR of a link that is not shared. (setcar x1 'baz) => baz x1 ; Only one list is changed. => (baz foo c) x2 => (z foo c) Here is a graphical depiction of the shared structure of the two lists in the variables `x1' and `x2', showing why replacing `b' changes them both: --- --- --- --- --- --- x1---> | | |----> | | |--> | | |--> nil --- --- --- --- --- --- | --> | | | | | | --> a | --> b --> c | --- --- | x2--> | | |-- --- --- | | --> z Here is an alternative form of box diagram, showing the same relationship: x1: -------------- -------------- -------------- | car | cdr | | car | cdr | | car | cdr | | a | o------->| b | o------->| c | nil | | | | -->| | | | | | -------------- | -------------- -------------- | x2: | -------------- | | car | cdr | | | z | o---- | | | -------------- Altering the CDR of a List -------------------------- The lowest-level primitive for modifying a CDR is `setcdr': - Function: setcdr CONS OBJECT This function stores OBJECT as the new CDR of CONS, replacing its previous CDR. In other words, it changes the CDR slot of CONS to point to OBJECT. It returns the value OBJECT. Here is an example of replacing the CDR of a list with a different list. All but the first element of the list are removed in favor of a different sequence of elements. The first element is unchanged, because it resides in the CAR of the list, and is not reached via the CDR. (setq x '(1 2 3)) => (1 2 3) (setcdr x '(4)) => (4) x => (1 4) You can delete elements from the middle of a list by altering the CDRs of the cons cells in the list. For example, here we delete the second element, `b', from the list `(a b c)', by changing the CDR of the first cons cell: (setq x1 '(a b c)) => (a b c) (setcdr x1 (cdr (cdr x1))) => (c) x1 => (a c) Here is the result in box notation: -------------------- | | -------------- | -------------- | -------------- | car | cdr | | | car | cdr | -->| car | cdr | | a | o----- | b | o-------->| c | nil | | | | | | | | | | -------------- -------------- -------------- The second cons cell, which previously held the element `b', still exists and its CAR is still `b', but it no longer forms part of this list. It is equally easy to insert a new element by changing CDRs: (setq x1 '(a b c)) => (a b c) (setcdr x1 (cons 'd (cdr x1))) => (d b c) x1 => (a d b c) Here is this result in box notation: -------------- ------------- ------------- | car | cdr | | car | cdr | | car | cdr | | a | o | -->| b | o------->| c | nil | | | | | | | | | | | | --------- | -- | ------------- ------------- | | ----- -------- | | | --------------- | | | car | cdr | | -->| d | o------ | | | --------------- Functions that Rearrange Lists ------------------------------ Here are some functions that rearrange lists "destructively" by modifying the CDRs of their component cons cells. We call these functions "destructive" because they chew up the original lists passed to them as arguments, relinking their cons cells to form a new list that is the returned value. See `delq', in *Note Sets And Lists::, for another function that modifies cons cells. - Function: nconc &rest LISTS This function returns a list containing all the elements of LISTS. Unlike `append' (*note Building Lists::.), the LISTS are *not* copied. Instead, the last CDR of each of the LISTS is changed to refer to the following list. The last of the LISTS is not altered. For example: (setq x '(1 2 3)) => (1 2 3) (nconc x '(4 5)) => (1 2 3 4 5) x => (1 2 3 4 5) Since the last argument of `nconc' is not itself modified, it is reasonable to use a constant list, such as `'(4 5)', as in the above example. For the same reason, the last argument need not be a list: (setq x '(1 2 3)) => (1 2 3) (nconc x 'z) => (1 2 3 . z) x => (1 2 3 . z) However, the other arguments (all but the last) must be lists. A common pitfall is to use a quoted constant list as a non-last argument to `nconc'. If you do this, your program will change each time you run it! Here is what happens: (defun add-foo (x) ; We want this function to add (nconc '(foo) x)) ; `foo' to the front of its arg. (symbol-function 'add-foo) => (lambda (x) (nconc (quote (foo)) x)) (setq xx (add-foo '(1 2))) ; It seems to work. => (foo 1 2) (setq xy (add-foo '(3 4))) ; What happened? => (foo 1 2 3 4) (eq xx xy) => t (symbol-function 'add-foo) => (lambda (x) (nconc (quote (foo 1 2 3 4) x))) - Function: nreverse LIST This function reverses the order of the elements of LIST. Unlike `reverse', `nreverse' alters its argument by reversing the CDRs in the cons cells forming the list. The cons cell that used to be the last one in LIST becomes the first cons cell of the value. For example: (setq x '(1 2 3 4)) => (1 2 3 4) x => (1 2 3 4) (nreverse x) => (4 3 2 1) ;; The cons cell that was first is now last. x => (1) To avoid confusion, we usually store the result of `nreverse' back in the same variable which held the original list: (setq x (nreverse x)) Here is the `nreverse' of our favorite example, `(a b c)', presented graphically: Original list head: Reversed list: ------------- ------------- ------------ | car | cdr | | car | cdr | | car | cdr | | a | nil |<-- | b | o |<-- | c | o | | | | | | | | | | | | | | ------------- | --------- | - | -------- | - | | | | ------------- ------------ - Function: sort LIST PREDICATE This function sorts LIST stably, though destructively, and returns the sorted list. It compares elements using PREDICATE. A stable sort is one in which elements with equal sort keys maintain their relative order before and after the sort. Stability is important when successive sorts are used to order elements according to different criteria. The argument PREDICATE must be a function that accepts two arguments. It is called with two elements of LIST. To get an increasing order sort, the PREDICATE should return `t' if the first element is "less than" the second, or `nil' if not. The comparison function PREDICATE must give reliable results for any given pair of arguments, at least within a single call to `sort'. It must be "antisymmetric"; that is, if A is less than B, B must not be less than A. It must be "transitive"--that is, if A is less than B, and B is less than C, then A must be less than C. If you use a comparison function which does not meet these requirements, the result of `sort' is unpredictable. The destructive aspect of `sort' is that it rearranges the cons cells forming LIST by changing CDRs. A nondestructive sort function would create new cons cells to store the elements in their sorted order. If you wish to make a sorted copy without destroying the original, copy it first with `copy-sequence' and then sort. Sorting does not change the CARs of the cons cells in LIST; the cons cell that originally contained the element `a' in LIST still has `a' in its CAR after sorting, but it now appears in a different position in the list due to the change of CDRs. For example: (setq nums '(1 3 2 6 5 4 0)) => (1 3 2 6 5 4 0) (sort nums '<) => (0 1 2 3 4 5 6) nums => (1 2 3 4 5 6) *Warning*: Note that the list in `nums' no longer contains 0; this is the same cons cell that it was before, but it is no longer the first one in the list. Don't assume a variable that formerly held the argument now holds the entire sorted list! Instead, save the result of `sort' and use that. Most often we store the result back into the variable that held the original list: (setq nums (sort nums '<)) *Note Sorting::, for more functions that perform sorting. See `documentation' in *Note Accessing Documentation::, for a useful example of `sort'. Using Lists as Sets =================== A list can represent an unordered mathematical set--simply consider a value an element of a set if it appears in the list, and ignore the order of the list. To form the union of two sets, use `append' (as long as you don't mind having duplicate elements). Other useful functions for sets include `memq' and `delq', and their `equal' versions, `member' and `delete'. Common Lisp note: Common Lisp has functions `union' (which avoids duplicate elements) and `intersection' for set operations, but GNU Emacs Lisp does not have them. You can write them in Lisp if you wish. - Function: memq OBJECT LIST This function tests to see whether OBJECT is a member of LIST. If it is, `memq' returns a list starting with the first occurrence of OBJECT. Otherwise, it returns `nil'. The letter `q' in `memq' says that it uses `eq' to compare OBJECT against the elements of the list. For example: (memq 'b '(a b c b a)) => (b c b a) (memq '(2) '((1) (2))) ; `(2)' and `(2)' are not `eq'. => nil - Function: delq OBJECT LIST This function destructively removes all elements `eq' to OBJECT from LIST. The letter `q' in `delq' says that it uses `eq' to compare OBJECT against the elements of the list, like `memq'. When `delq' deletes elements from the front of the list, it does so simply by advancing down the list and returning a sublist that starts after those elements: (delq 'a '(a b c)) == (cdr '(a b c)) When an element to be deleted appears in the middle of the list, removing it involves changing the CDRs (*note Setcdr::.). (setq sample-list '(a b c (4))) => (a b c (4)) (delq 'a sample-list) => (b c (4)) sample-list => (a b c (4)) (delq 'c sample-list) => (a b (4)) sample-list => (a b (4)) Note that `(delq 'c sample-list)' modifies `sample-list' to splice out the third element, but `(delq 'a sample-list)' does not splice anything--it just returns a shorter list. Don't assume that a variable which formerly held the argument LIST now has fewer elements, or that it still holds the original list! Instead, save the result of `delq' and use that. Most often we store the result back into the variable that held the original list: (setq flowers (delq 'rose flowers)) In the following example, the `(4)' that `delq' attempts to match and the `(4)' in the `sample-list' are not `eq': (delq '(4) sample-list) => (a c (4)) The following two functions are like `memq' and `delq' but use `equal' rather than `eq' to compare elements. *Note Equality Predicates::. - Function: member OBJECT LIST The function `member' tests to see whether OBJECT is a member of LIST, comparing members with OBJECT using `equal'. If OBJECT is a member, `member' returns a list starting with its first occurrence in LIST. Otherwise, it returns `nil'. Compare this with `memq': (member '(2) '((1) (2))) ; `(2)' and `(2)' are `equal'. => ((2)) (memq '(2) '((1) (2))) ; `(2)' and `(2)' are not `eq'. => nil ;; Two strings with the same contents are `equal'. (member "foo" '("foo" "bar")) => ("foo" "bar") - Function: delete OBJECT LIST This function destructively removes all elements `equal' to OBJECT from LIST. It is to `delq' as `member' is to `memq': it uses `equal' to compare elements with OBJECT, like `member'; when it finds an element that matches, it removes the element just as `delq' would. For example: (delete '(2) '((2) (1) (2))) => ((1)) Common Lisp note: The functions `member' and `delete' in GNU Emacs Lisp are derived from Maclisp, not Common Lisp. The Common Lisp versions do not use `equal' to compare elements. See also the function `add-to-list', in *Note Setting Variables::, for another way to add an element to a list stored in a variable. Association Lists ================= An "association list", or "alist" for short, records a mapping from keys to values. It is a list of cons cells called "associations": the CAR of each cons cell is the "key", and the CDR is the "associated value".(1) Here is an example of an alist. The key `pine' is associated with the value `cones'; the key `oak' is associated with `acorns'; and the key `maple' is associated with `seeds'. '((pine . cones) (oak . acorns) (maple . seeds)) The associated values in an alist may be any Lisp objects; so may the keys. For example, in the following alist, the symbol `a' is associated with the number `1', and the string `"b"' is associated with the *list* `(2 3)', which is the CDR of the alist element: ((a . 1) ("b" 2 3)) Sometimes it is better to design an alist to store the associated value in the CAR of the CDR of the element. Here is an example: '((rose red) (lily white) (buttercup yellow)) Here we regard `red' as the value associated with `rose'. One advantage of this kind of alist is that you can store other related information--even a list of other items--in the CDR of the CDR. One disadvantage is that you cannot use `rassq' (see below) to find the element containing a given value. When neither of these considerations is important, the choice is a matter of taste, as long as you are consistent about it for any given alist. Note that the same alist shown above could be regarded as having the associated value in the CDR of the element; the value associated with `rose' would be the list `(red)'. Association lists are often used to record information that you might otherwise keep on a stack, since new associations may be added easily to the front of the list. When searching an association list for an association with a given key, the first one found is returned, if there is more than one. In Emacs Lisp, it is *not* an error if an element of an association list is not a cons cell. The alist search functions simply ignore such elements. Many other versions of Lisp signal errors in such cases. Note that property lists are similar to association lists in several respects. A property list behaves like an association list in which each key can occur only once. *Note Property Lists::, for a comparison of property lists and association lists. - Function: assoc KEY ALIST This function returns the first association for KEY in ALIST. It compares KEY against the alist elements using `equal' (*note Equality Predicates::.). It returns `nil' if no association in ALIST has a CAR `equal' to KEY. For example: (setq trees '((pine . cones) (oak . acorns) (maple . seeds))) => ((pine . cones) (oak . acorns) (maple . seeds)) (assoc 'oak trees) => (oak . acorns) (cdr (assoc 'oak trees)) => acorns (assoc 'birch trees) => nil Here is another example, in which the keys and values are not symbols: (setq needles-per-cluster '((2 "Austrian Pine" "Red Pine") (3 "Pitch Pine") (5 "White Pine"))) (cdr (assoc 3 needles-per-cluster)) => ("Pitch Pine") (cdr (assoc 2 needles-per-cluster)) => ("Austrian Pine" "Red Pine") The functions `assoc-ignore-representation' and `assoc-ignore-case' are much like `assoc' except using `compare-strings' to do the comparison. *Note Text Comparison::. - Function: rassoc VALUE ALIST This function returns the first association with value VALUE in ALIST. It returns `nil' if no association in ALIST has a CDR `equal' to VALUE. `rassoc' is like `assoc' except that it compares the CDR of each ALIST association instead of the CAR. You can think of this as "reverse `assoc'", finding the key for a given value. - Function: assq KEY ALIST This function is like `assoc' in that it returns the first association for KEY in ALIST, but it makes the comparison using `eq' instead of `equal'. `assq' returns `nil' if no association in ALIST has a CAR `eq' to KEY. This function is used more often than `assoc', since `eq' is faster than `equal' and most alists use symbols as keys. *Note Equality Predicates::. (setq trees '((pine . cones) (oak . acorns) (maple . seeds))) => ((pine . cones) (oak . acorns) (maple . seeds)) (assq 'pine trees) => (pine . cones) On the other hand, `assq' is not usually useful in alists where the keys may not be symbols: (setq leaves '(("simple leaves" . oak) ("compound leaves" . horsechestnut))) (assq "simple leaves" leaves) => nil (assoc "simple leaves" leaves) => ("simple leaves" . oak) - Function: rassq VALUE ALIST This function returns the first association with value VALUE in ALIST. It returns `nil' if no association in ALIST has a CDR `eq' to VALUE. `rassq' is like `assq' except that it compares the CDR of each ALIST association instead of the CAR. You can think of this as "reverse `assq'", finding the key for a given value. For example: (setq trees '((pine . cones) (oak . acorns) (maple . seeds))) (rassq 'acorns trees) => (oak . acorns) (rassq 'spores trees) => nil Note that `rassq' cannot search for a value stored in the CAR of the CDR of an element: (setq colors '((rose red) (lily white) (buttercup yellow))) (rassq 'white colors) => nil In this case, the CDR of the association `(lily white)' is not the symbol `white', but rather the list `(white)'. This becomes clearer if the association is written in dotted pair notation: (lily white) == (lily . (white)) - Function: assoc-default KEY ALIST TEST DEFAULT This function searches ALIST for a match for KEY. For each element of ALIST, it compares the element (if it is an atom) or the element's CAR (if it is a cons) against KEY, by calling TEST with two arguments: the element or its CAR, and KEY. The arguments are passed in that order so that you can get useful results using `string-match' with an alist that contains regular expressions (*note Regexp Search::.). If TEST is omitted or `nil', `equal' is used for comparison. If an alist element matches KEY by this criterion, then `assoc-default' returns a value based on this element. If the element is a cons, then the value is the element's CDR. Otherwise, the return value is DEFAULT. If no alist element matches KEY, `assoc-default' returns `nil'. - Function: copy-alist ALIST This function returns a two-level deep copy of ALIST: it creates a new copy of each association, so that you can alter the associations of the new alist without changing the old one. (setq needles-per-cluster '((2 . ("Austrian Pine" "Red Pine")) (3 . ("Pitch Pine")) (5 . ("White Pine")))) => ((2 "Austrian Pine" "Red Pine") (3 "Pitch Pine") (5 "White Pine")) (setq copy (copy-alist needles-per-cluster)) => ((2 "Austrian Pine" "Red Pine") (3 "Pitch Pine") (5 "White Pine")) (eq needles-per-cluster copy) => nil (equal needles-per-cluster copy) => t (eq (car needles-per-cluster) (car copy)) => nil (cdr (car (cdr needles-per-cluster))) => ("Pitch Pine") (eq (cdr (car (cdr needles-per-cluster))) (cdr (car (cdr copy)))) => t This example shows how `copy-alist' makes it possible to change the associations of one copy without affecting the other: (setcdr (assq 3 copy) '("Martian Vacuum Pine")) (cdr (assq 3 needles-per-cluster)) => ("Pitch Pine") ---------- Footnotes ---------- (1) This usage of "key" is not related to the term "key sequence"; it means a value used to look up an item in a table. In this case, the table is the alist, and the alist associations are the items. Sequences, Arrays, and Vectors ****************************** Recall that the "sequence" type is the union of two other Lisp types: lists and arrays. In other words, any list is a sequence, and any array is a sequence. The common property that all sequences have is that each is an ordered collection of elements. An "array" is a single primitive object that has a slot for each of its elements. All the elements are accessible in constant time, but the length of an existing array cannot be changed. Strings, vectors, char-tables and bool-vectors are the four types of arrays. A list is a sequence of elements, but it is not a single primitive object; it is made of cons cells, one cell per element. Finding the Nth element requires looking through N cons cells, so elements farther from the beginning of the list take longer to access. But it is possible to add elements to the list, or remove elements. The following diagram shows the relationship between these types: _____________________________________________ | | | Sequence | | ______ ________________________________ | | | | | | | | | List | | Array | | | | | | ________ ________ | | | |______| | | | | | | | | | | Vector | | String | | | | | |________| |________| | | | | ____________ _____________ | | | | | | | | | | | | | Char-table | | Bool-vector | | | | | |____________| |_____________| | | | |________________________________| | |_____________________________________________| The elements of vectors and lists may be any Lisp objects. The elements of strings are all characters. Sequences ========= In Emacs Lisp, a "sequence" is either a list or an array. The common property of all sequences is that they are ordered collections of elements. This section describes functions that accept any kind of sequence. - Function: sequencep OBJECT Returns `t' if OBJECT is a list, vector, or string, `nil' otherwise. - Function: length SEQUENCE This function returns the number of elements in SEQUENCE. If SEQUENCE is a cons cell that is not a list (because the final CDR is not `nil'), a `wrong-type-argument' error is signaled. *Note List Elements::, for the related function `safe-length'. (length '(1 2 3)) => 3 (length ()) => 0 (length "foobar") => 6 (length [1 2 3]) => 3 (length (make-bool-vector 5 nil)) => 5 - Function: elt SEQUENCE INDEX This function returns the element of SEQUENCE indexed by INDEX. Legitimate values of INDEX are integers ranging from 0 up to one less than the length of SEQUENCE. If SEQUENCE is a list, then out-of-range values of INDEX return `nil'; otherwise, they trigger an `args-out-of-range' error. (elt [1 2 3 4] 2) => 3 (elt '(1 2 3 4) 2) => 3 ;; We use `string' to show clearly which character `elt' returns. (string (elt "1234" 2)) => "3" (elt [1 2 3 4] 4) error--> Args out of range: [1 2 3 4], 4 (elt [1 2 3 4] -1) error--> Args out of range: [1 2 3 4], -1 This function generalizes `aref' (*note Array Functions::.) and `nth' (*note List Elements::.). - Function: copy-sequence SEQUENCE Returns a copy of SEQUENCE. The copy is the same type of object as the original sequence, and it has the same elements in the same order. Storing a new element into the copy does not affect the original SEQUENCE, and vice versa. However, the elements of the new sequence are not copies; they are identical (`eq') to the elements of the original. Therefore, changes made within these elements, as found via the copied sequence, are also visible in the original sequence. If the sequence is a string with text properties, the property list in the copy is itself a copy, not shared with the original's property list. However, the actual values of the properties are shared. *Note Text Properties::. See also `append' in *Note Building Lists::, `concat' in *Note Creating Strings::, and `vconcat' in *Note Vectors::, for others ways to copy sequences. (setq bar '(1 2)) => (1 2) (setq x (vector 'foo bar)) => [foo (1 2)] (setq y (copy-sequence x)) => [foo (1 2)] (eq x y) => nil (equal x y) => t (eq (elt x 1) (elt y 1)) => t ;; Replacing an element of one sequence. (aset x 0 'quux) x => [quux (1 2)] y => [foo (1 2)] ;; Modifying the inside of a shared element. (setcar (aref x 1) 69) x => [quux (69 2)] y => [foo (69 2)] Arrays ====== An "array" object has slots that hold a number of other Lisp objects, called the elements of the array. Any element of an array may be accessed in constant time. In contrast, an element of a list requires access time that is proportional to the position of the element in the list. Emacs defines four types of array, all one-dimensional: "strings", "vectors", "bool-vectors" and "char-tables". A vector is a general array; its elements can be any Lisp objects. A string is a specialized array; its elements must be characters (i.e., integers between 0 and 255). Each type of array has its own read syntax. *Note String Type::, and *Note Vector Type::. All four kinds of array share these characteristics: * The first element of an array has index zero, the second element has index 1, and so on. This is called "zero-origin" indexing. For example, an array of four elements has indices 0, 1, 2, and 3. * The length of the array is fixed once you create it; you cannot change the length of an existing array. * The array is a constant, for evaluation--in other words, it evaluates to itself. * The elements of an array may be referenced or changed with the functions `aref' and `aset', respectively (*note Array Functions::.). When you create an array, other than a char-table, you must specify its length. You cannot specify the length of a char-table, because that is determined by the range of character codes. In principle, if you want an array of text characters, you could use either a string or a vector. In practice, we always choose strings for such applications, for four reasons: * They occupy one-fourth the space of a vector of the same elements. * Strings are printed in a way that shows the contents more clearly as text. * Strings can hold text properties. *Note Text Properties::. * Many of the specialized editing and I/O facilities of Emacs accept only strings. For example, you cannot insert a vector of characters into a buffer the way you can insert a string. *Note Strings and Characters::. By contrast, for an array of keyboard input characters (such as a key sequence), a vector may be necessary, because many keyboard input characters are outside the range that will fit in a string. *Note Key Sequence Input::. Functions that Operate on Arrays ================================ In this section, we describe the functions that accept all types of arrays. - Function: arrayp OBJECT This function returns `t' if OBJECT is an array (i.e., a vector, a string, a bool-vector or a char-table). (arrayp [a]) => t (arrayp "asdf") => t (arrayp (syntax-table)) ;; A char-table. => t - Function: aref ARRAY INDEX This function returns the INDEXth element of ARRAY. The first element is at index zero. (setq primes [2 3 5 7 11 13]) => [2 3 5 7 11 13] (aref primes 4) => 11 (aref "abcdefg" 1) => 98 ; `b' is ASCII code 98. See also the function `elt', in *Note Sequence Functions::. - Function: aset ARRAY INDEX OBJECT This function sets the INDEXth element of ARRAY to be OBJECT. It returns OBJECT. (setq w [foo bar baz]) => [foo bar baz] (aset w 0 'fu) => fu w => [fu bar baz] (setq x "asdfasfd") => "asdfasfd" (aset x 3 ?Z) => 90 x => "asdZasfd" If ARRAY is a string and OBJECT is not a character, a `wrong-type-argument' error results. If ARRAY is a string and OBJECT is character, but OBJECT does not use the same number of bytes as the character currently stored in `(aref OBJECT INDEX)', that is also an error. *Note Splitting Characters::. - Function: fillarray ARRAY OBJECT This function fills the array ARRAY with OBJECT, so that each element of ARRAY is OBJECT. It returns ARRAY. (setq a [a b c d e f g]) => [a b c d e f g] (fillarray a 0) => [0 0 0 0 0 0 0] a => [0 0 0 0 0 0 0] (setq s "When in the course") => "When in the course" (fillarray s ?-) => "------------------" If ARRAY is a string and OBJECT is not a character, a `wrong-type-argument' error results. The general sequence functions `copy-sequence' and `length' are often useful for objects known to be arrays. *Note Sequence Functions::. Vectors ======= Arrays in Lisp, like arrays in most languages, are blocks of memory whose elements can be accessed in constant time. A "vector" is a general-purpose array of specified length; its elements can be any Lisp objects. (By contrast, a string can hold only characters as elements.) Vectors in Emacs are used for obarrays (vectors of symbols), and as part of keymaps (vectors of commands). They are also used internally as part of the representation of a byte-compiled function; if you print such a function, you will see a vector in it. In Emacs Lisp, the indices of the elements of a vector start from zero and count up from there. Vectors are printed with square brackets surrounding the elements. Thus, a vector whose elements are the symbols `a', `b' and `a' is printed as `[a b a]'. You can write vectors in the same way in Lisp input. A vector, like a string or a number, is considered a constant for evaluation: the result of evaluating it is the same vector. This does not evaluate or even examine the elements of the vector. *Note Self-Evaluating Forms::. Here are examples illustrating these principles: (setq avector [1 two '(three) "four" [five]]) => [1 two (quote (three)) "four" [five]] (eval avector) => [1 two (quote (three)) "four" [five]] (eq avector (eval avector)) => t Functions for Vectors ===================== Here are some functions that relate to vectors: - Function: vectorp OBJECT This function returns `t' if OBJECT is a vector. (vectorp [a]) => t (vectorp "asdf") => nil - Function: vector &rest OBJECTS This function creates and returns a vector whose elements are the arguments, OBJECTS. (vector 'foo 23 [bar baz] "rats") => [foo 23 [bar baz] "rats"] (vector) => [] - Function: make-vector LENGTH OBJECT This function returns a new vector consisting of LENGTH elements, each initialized to OBJECT. (setq sleepy (make-vector 9 'Z)) => [Z Z Z Z Z Z Z Z Z] - Function: vconcat &rest SEQUENCES This function returns a new vector containing all the elements of the SEQUENCES. The arguments SEQUENCES may be any kind of arrays, including lists, vectors, or strings. If no SEQUENCES are given, an empty vector is returned. The value is a newly constructed vector that is not `eq' to any existing vector. (setq a (vconcat '(A B C) '(D E F))) => [A B C D E F] (eq a (vconcat a)) => nil (vconcat) => [] (vconcat [A B C] "aa" '(foo (6 7))) => [A B C 97 97 foo (6 7)] The `vconcat' function also allows byte-code function objects as arguments. This is a special feature to make it easy to access the entire contents of a byte-code function object. *Note Byte-Code Objects::. The `vconcat' function also allows integers as arguments. It converts them to strings of digits, making up the decimal print representation of the integer, and then uses the strings instead of the original integers. *Don't use this feature; we plan to eliminate it. If you already use this feature, change your programs now!* The proper way to convert an integer to a decimal number in this way is with `format' (*note Formatting Strings::.) or `number-to-string' (*note String Conversion::.). For other concatenation functions, see `mapconcat' in *Note Mapping Functions::, `concat' in *Note Creating Strings::, and `append' in *Note Building Lists::. The `append' function provides a way to convert a vector into a list with the same elements (*note Building Lists::.): (setq avector [1 two (quote (three)) "four" [five]]) => [1 two (quote (three)) "four" [five]] (append avector nil) => (1 two (quote (three)) "four" [five]) Char-Tables =========== A char-table is much like a vector, except that it is indexed by character codes. Any valid character code, without modifiers, can be used as an index in a char-table. You can access a char-table's elements with `aref' and `aset', as with any array. In addition, a char-table can have "extra slots" to hold additional data not associated with particular character codes. Char-tables are constants when evaluated. Each char-table has a "subtype" which is a symbol. The subtype has two purposes: to distinguish char-tables meant for different uses, and to control the number of extra slots. For example, display tables are char-tables with `display-table' as the subtype, and syntax tables are char-tables with `syntax-table' as the subtype. A valid subtype must have a `char-table-extra-slots' property which is an integer between 0 and 10. This integer specifies the number of "extra slots" in the char-table. A char-table can have a "parent". which is another char-table. If it does, then whenever the char-table specifies `nil' for a particular character C, it inherits the value specified in the parent. In other words, `(aref CHAR-TABLE C)' returns the value from the parent of CHAR-TABLE if CHAR-TABLE itself specifies `nil'. A char-table can also have a "default value". If so, then `(aref CHAR-TABLE C)' returns the default value whenever the char-table does not specify any other non-`nil' value. - Function: make-char-table SUBTYPE &optional INIT Return a newly created char-table, with subtype SUBTYPE. Each element is initialized to INIT, which defaults to `nil'. You cannot alter the subtype of a char-table after the char-table is created. There is no argument to specify the length of the char-table, because all char-tables have room for any valid character code as an index. - Function: char-table-p OBJECT This function returns `t' if OBJECT is a char-table, otherwise `nil'. - Function: char-table-subtype CHAR-TABLE This function returns the subtype symbol of CHAR-TABLE. - Function: set-char-table-default CHAR-TABLE NEW-DEFAULT This function sets the default value of CHAR-TABLE to NEW-DEFAULT. There is no special function to access the default value of a char-table. To do that, use `(char-table-range CHAR-TABLE nil)'. - Function: char-table-parent CHAR-TABLE This function returns the parent of CHAR-TABLE. The parent is always either `nil' or another char-table. - Function: set-char-table-parent CHAR-TABLE NEW-PARENT This function sets the parent of CHAR-TABLE to NEW-PARENT. - Function: char-table-extra-slot CHAR-TABLE N This function returns the contents of extra slot N of CHAR-TABLE. The number of extra slots in a char-table is determined by its subtype. - Function: set-char-table-extra-slot CHAR-TABLE N VALUE This function stores VALUE in extra slot N of CHAR-TABLE. A char-table can specify an element value for a single character code; it can also specify a value for an entire character set. - Function: char-table-range CHAR-TABLE RANGE This returns the value specified in CHAR-TABLE for a range of characters RANGE. Here are the possibilities for RANGE: `nil' Refers to the default value. CHAR Refers to the element for character CHAR (supposing CHAR is a valid character code). CHARSET Refers to the value specified for the whole character set CHARSET (*note Character Sets::.). GENERIC-CHAR A generic character stands for a character set; specifying the generic character as argument is equivalent to specifying the character set name. *Note Splitting Characters::, for a description of generic characters. - Function: set-char-table-range CHAR-TABLE RANGE VALUE This function sets the value in CHAR-TABLE for a range of characters RANGE. Here are the possibilities for RANGE: `nil' Refers to the default value. `t' Refers to the whole range of character codes. CHAR Refers to the element for character CHAR (supposing CHAR is a valid character code). CHARSET Refers to the value specified for the whole character set CHARSET (*note Character Sets::.). GENERIC-CHAR A generic character stands for a character set; specifying the generic character as argument is equivalent to specifying the character set name. *Note Splitting Characters::, for a description of generic characters. - Function: map-char-table FUNCTION CHAR-TABLE This function calls FUNCTION for each element of CHAR-TABLE. FUNCTION is called with two arguments, a key and a value. The key is a possible RANGE argument for `char-table-range'--either a valid character or a generic character--and the value is `(char-table-range CHAR-TABLE KEY)'. Overall, the key-value pairs passed to FUNCTION describe all the values stored in CHAR-TABLE. The return value is always `nil'; to make this function useful, FUNCTION should have side effects. For example, here is how to examine each element of the syntax table: (let (accumulator) (map-char-table #'(lambda (key value) (setq accumulator (cons (list key value) accumulator))) (syntax-table)) accumulator) => ((475008 nil) (474880 nil) (474752 nil) (474624 nil) ... (5 (3)) (4 (3)) (3 (3)) (2 (3)) (1 (3)) (0 (3))) Bool-vectors ============ A bool-vector is much like a vector, except that it stores only the values `t' and `nil'. If you try to store any non-`nil' value into an element of the bool-vector, the effect is to store `t' there. As with all arrays, bool-vector indices start from 0, and the length cannot be changed once the bool-vector is created. Bool-vectors are constants when evaluated. There are two special functions for working with bool-vectors; aside from that, you manipulate them with same functions used for other kinds of arrays. - Function: make-bool-vector LENGTH INITIAL Return a new book-vector of LENGTH elements, each one initialized to INITIAL. - Function: bool-vector-p OBJECT This returns `t' if OBJECT is a bool-vector, and `nil' otherwise. Symbols ******* A "symbol" is an object with a unique name. This chapter describes symbols, their components, their property lists, and how they are created and interned. Separate chapters describe the use of symbols as variables and as function names; see *Note Variables::, and *Note Functions::. For the precise read syntax for symbols, see *Note Symbol Type::. You can test whether an arbitrary Lisp object is a symbol with `symbolp': - Function: symbolp OBJECT This function returns `t' if OBJECT is a symbol, `nil' otherwise. Symbol Components ================= Each symbol has four components (or "cells"), each of which references another object: Print name The "print name cell" holds a string that names the symbol for reading and printing. See `symbol-name' in *Note Creating Symbols::. Value The "value cell" holds the current value of the symbol as a variable. When a symbol is used as a form, the value of the form is the contents of the symbol's value cell. See `symbol-value' in *Note Accessing Variables::. Function The "function cell" holds the function definition of the symbol. When a symbol is used as a function, its function definition is used in its place. This cell is also used to make a symbol stand for a keymap or a keyboard macro, for editor command execution. Because each symbol has separate value and function cells, variables and function names do not conflict. See `symbol-function' in *Note Function Cells::. Property list The "property list cell" holds the property list of the symbol. See `symbol-plist' in *Note Property Lists::. The print name cell always holds a string, and cannot be changed. The other three cells can be set individually to any specified Lisp object. The print name cell holds the string that is the name of the symbol. Since symbols are represented textually by their names, it is important not to have two symbols with the same name. The Lisp reader ensures this: every time it reads a symbol, it looks for an existing symbol with the specified name before it creates a new one. (In GNU Emacs Lisp, this lookup uses a hashing algorithm and an obarray; see *Note Creating Symbols::.) In normal usage, the function cell usually contains a function (*note Functions::.) or a macro (*note Macros::.), as that is what the Lisp interpreter expects to see there (*note Evaluation::.). Keyboard macros (*note Keyboard Macros::.), keymaps (*note Keymaps::.) and autoload objects (*note Autoloading::.) are also sometimes stored in the function cells of symbols. We often refer to "the function `foo'" when we really mean the function stored in the function cell of the symbol `foo'. We make the distinction only when necessary. The property list cell normally should hold a correctly formatted property list (*note Property Lists::.), as a number of functions expect to see a property list there. The function cell or the value cell may be "void", which means that the cell does not reference any object. (This is not the same thing as holding the symbol `void', nor the same as holding the symbol `nil'.) Examining a function or value cell that is void results in an error, such as `Symbol's value as variable is void'. The four functions `symbol-name', `symbol-value', `symbol-plist', and `symbol-function' return the contents of the four cells of a symbol. Here as an example we show the contents of the four cells of the symbol `buffer-file-name': (symbol-name 'buffer-file-name) => "buffer-file-name" (symbol-value 'buffer-file-name) => "/gnu/elisp/symbols.texi" (symbol-plist 'buffer-file-name) => (variable-documentation 29529) (symbol-function 'buffer-file-name) => # Because this symbol is the variable which holds the name of the file being visited in the current buffer, the value cell contents we see are the name of the source file of this chapter of the Emacs Lisp Manual. The property list cell contains the list `(variable-documentation 29529)' which tells the documentation functions where to find the documentation string for the variable `buffer-file-name' in the `DOC-VERSION' file. (29529 is the offset from the beginning of the `DOC-VERSION' file to where that documentation string begins--see *Note Documentation Basics::.) The function cell contains the function for returning the name of the file. `buffer-file-name' names a primitive function, which has no read syntax and prints in hash notation (*note Primitive Function Type::.). A symbol naming a function written in Lisp would have a lambda expression (or a byte-code object) in this cell. Defining Symbols ================ A "definition" in Lisp is a special form that announces your intention to use a certain symbol in a particular way. In Emacs Lisp, you can define a symbol as a variable, or define it as a function (or macro), or both independently. A definition construct typically specifies a value or meaning for the symbol for one kind of use, plus documentation for its meaning when used in this way. Thus, when you define a symbol as a variable, you can supply an initial value for the variable, plus documentation for the variable. `defvar' and `defconst' are special forms that define a symbol as a global variable. They are documented in detail in *Note Defining Variables::. For defining user option variables that can be customized, use `defcustom' (*note Customization::.). `defun' defines a symbol as a function, creating a lambda expression and storing it in the function cell of the symbol. This lambda expression thus becomes the function definition of the symbol. (The term "function definition", meaning the contents of the function cell, is derived from the idea that `defun' gives the symbol its definition as a function.) `defsubst' and `defalias' are two other ways of defining a function. *Note Functions::. `defmacro' defines a symbol as a macro. It creates a macro object and stores it in the function cell of the symbol. Note that a given symbol can be a macro or a function, but not both at once, because both macro and function definitions are kept in the function cell, and that cell can hold only one Lisp object at any given time. *Note Macros::. In Emacs Lisp, a definition is not required in order to use a symbol as a variable or function. Thus, you can make a symbol a global variable with `setq', whether you define it first or not. The real purpose of definitions is to guide programmers and programming tools. They inform programmers who read the code that certain symbols are *intended* to be used as variables, or as functions. In addition, utilities such as `etags' and `make-docfile' recognize definitions, and add appropriate information to tag tables and the `DOC-VERSION' file. *Note Accessing Documentation::. Creating and Interning Symbols ============================== To understand how symbols are created in GNU Emacs Lisp, you must know how Lisp reads them. Lisp must ensure that it finds the same symbol every time it reads the same set of characters. Failure to do so would cause complete confusion. When the Lisp reader encounters a symbol, it reads all the characters of the name. Then it "hashes" those characters to find an index in a table called an "obarray". Hashing is an efficient method of looking something up. For example, instead of searching a telephone book cover to cover when looking up Jan Jones, you start with the J's and go from there. That is a simple version of hashing. Each element of the obarray is a "bucket" which holds all the symbols with a given hash code; to look for a given name, it is sufficient to look through all the symbols in the bucket for that name's hash code. If a symbol with the desired name is found, the reader uses that symbol. If the obarray does not contain a symbol with that name, the reader makes a new symbol and adds it to the obarray. Finding or adding a symbol with a certain name is called "interning" it, and the symbol is then called an "interned symbol". Interning ensures that each obarray has just one symbol with any particular name. Other like-named symbols may exist, but not in the same obarray. Thus, the reader gets the same symbols for the same names, as long as you keep reading with the same obarray. No obarray contains all symbols; in fact, some symbols are not in any obarray. They are called "uninterned symbols". An uninterned symbol has the same four cells as other symbols; however, the only way to gain access to it is by finding it in some other object or as the value of a variable. In Emacs Lisp, an obarray is actually a vector. Each element of the vector is a bucket; its value is either an interned symbol whose name hashes to that bucket, or 0 if the bucket is empty. Each interned symbol has an internal link (invisible to the user) to the next symbol in the bucket. Because these links are invisible, there is no way to find all the symbols in an obarray except using `mapatoms' (below). The order of symbols in a bucket is not significant. In an empty obarray, every element is 0, and you can create an obarray with `(make-vector LENGTH 0)'. *This is the only valid way to create an obarray.* Prime numbers as lengths tend to result in good hashing; lengths one less than a power of two are also good. *Do not try to put symbols in an obarray yourself.* This does not work--only `intern' can enter a symbol in an obarray properly. Common Lisp note: In Common Lisp, a single symbol may be interned in several obarrays. Most of the functions below take a name and sometimes an obarray as arguments. A `wrong-type-argument' error is signaled if the name is not a string, or if the obarray is not a vector. - Function: symbol-name SYMBOL This function returns the string that is SYMBOL's name. For example: (symbol-name 'foo) => "foo" *Warning:* Changing the string by substituting characters does change the name of the symbol, but fails to update the obarray, so don't do it! - Function: make-symbol NAME This function returns a newly-allocated, uninterned symbol whose name is NAME (which must be a string). Its value and function definition are void, and its property list is `nil'. In the example below, the value of `sym' is not `eq' to `foo' because it is a distinct uninterned symbol whose name is also `foo'. (setq sym (make-symbol "foo")) => foo (eq sym 'foo) => nil - Function: intern NAME &optional OBARRAY This function returns the interned symbol whose name is NAME. If there is no such symbol in the obarray OBARRAY, `intern' creates a new one, adds it to the obarray, and returns it. If OBARRAY is omitted, the value of the global variable `obarray' is used. (setq sym (intern "foo")) => foo (eq sym 'foo) => t (setq sym1 (intern "foo" other-obarray)) => foo (eq sym 'foo) => nil Common Lisp note: In Common Lisp, you can intern an existing symbol in an obarray. In Emacs Lisp, you cannot do this, because the argument to `intern' must be a string, not a symbol. - Function: intern-soft NAME &optional OBARRAY This function returns the symbol in OBARRAY whose name is NAME, or `nil' if OBARRAY has no symbol with that name. Therefore, you can use `intern-soft' to test whether a symbol with a given name is already interned. If OBARRAY is omitted, the value of the global variable `obarray' is used. (intern-soft "frazzle") ; No such symbol exists. => nil (make-symbol "frazzle") ; Create an uninterned one. => frazzle (intern-soft "frazzle") ; That one cannot be found. => nil (setq sym (intern "frazzle")) ; Create an interned one. => frazzle (intern-soft "frazzle") ; That one can be found! => frazzle (eq sym 'frazzle) ; And it is the same one. => t - Variable: obarray This variable is the standard obarray for use by `intern' and `read'. - Function: mapatoms FUNCTION &optional OBARRAY This function calls FUNCTION once with each symbol in the obarray OBARRAY. Then it returns `nil'. If OBARRAY is omitted, it defaults to the value of `obarray', the standard obarray for ordinary symbols. (setq count 0) => 0 (defun count-syms (s) (setq count (1+ count))) => count-syms (mapatoms 'count-syms) => nil count => 1871 See `documentation' in *Note Accessing Documentation::, for another example using `mapatoms'. - Function: unintern SYMBOL &optional OBARRAY This function deletes SYMBOL from the obarray OBARRAY. If `symbol' is not actually in the obarray, `unintern' does nothing. If OBARRAY is `nil', the current obarray is used. If you provide a string instead of a symbol as SYMBOL, it stands for a symbol name. Then `unintern' deletes the symbol (if any) in the obarray which has that name. If there is no such symbol, `unintern' does nothing. If `unintern' does delete a symbol, it returns `t'. Otherwise it returns `nil'. Property Lists ============== A "property list" ("plist" for short) is a list of paired elements stored in the property list cell of a symbol. Each of the pairs associates a property name (usually a symbol) with a property or value. Property lists are generally used to record information about a symbol, such as its documentation as a variable, the name of the file where it was defined, or perhaps even the grammatical class of the symbol (representing a word) in a language-understanding system. Character positions in a string or buffer can also have property lists. *Note Text Properties::. The property names and values in a property list can be any Lisp objects, but the names are usually symbols. Property list functions compare the property names using `eq'. Here is an example of a property list, found on the symbol `progn' when the compiler is loaded: (lisp-indent-function 0 byte-compile byte-compile-progn) Here `lisp-indent-function' and `byte-compile' are property names, and the other two elements are the corresponding values. Property Lists and Association Lists ------------------------------------ Association lists (*note Association Lists::.) are very similar to property lists. In contrast to association lists, the order of the pairs in the property list is not significant since the property names must be distinct. Property lists are better than association lists for attaching information to various Lisp function names or variables. If your program keeps all of its associations in one association list, it will typically need to search that entire list each time it checks for an association. This could be slow. By contrast, if you keep the same information in the property lists of the function names or variables themselves, each search will scan only the length of one property list, which is usually short. This is why the documentation for a variable is recorded in a property named `variable-documentation'. The byte compiler likewise uses properties to record those functions needing special treatment. However, association lists have their own advantages. Depending on your application, it may be faster to add an association to the front of an association list than to update a property. All properties for a symbol are stored in the same property list, so there is a possibility of a conflict between different uses of a property name. (For this reason, it is a good idea to choose property names that are probably unique, such as by beginning the property name with the program's usual name-prefix for variables and functions.) An association list may be used like a stack where associations are pushed on the front of the list and later discarded; this is not possible with a property list. Property List Functions for Symbols ----------------------------------- - Function: symbol-plist SYMBOL This function returns the property list of SYMBOL. - Function: setplist SYMBOL PLIST This function sets SYMBOL's property list to PLIST. Normally, PLIST should be a well-formed property list, but this is not enforced. (setplist 'foo '(a 1 b (2 3) c nil)) => (a 1 b (2 3) c nil) (symbol-plist 'foo) => (a 1 b (2 3) c nil) For symbols in special obarrays, which are not used for ordinary purposes, it may make sense to use the property list cell in a nonstandard fashion; in fact, the abbrev mechanism does so (*note Abbrevs::.). - Function: get SYMBOL PROPERTY This function finds the value of the property named PROPERTY in SYMBOL's property list. If there is no such property, `nil' is returned. Thus, there is no distinction between a value of `nil' and the absence of the property. The name PROPERTY is compared with the existing property names using `eq', so any object is a legitimate property. See `put' for an example. - Function: put SYMBOL PROPERTY VALUE This function puts VALUE onto SYMBOL's property list under the property name PROPERTY, replacing any previous property value. The `put' function returns VALUE. (put 'fly 'verb 'transitive) =>'transitive (put 'fly 'noun '(a buzzing little bug)) => (a buzzing little bug) (get 'fly 'verb) => transitive (symbol-plist 'fly) => (verb transitive noun (a buzzing little bug)) Property Lists Outside Symbols ------------------------------ These two functions are useful for manipulating property lists that are stored in places other than symbols: - Function: plist-get PLIST PROPERTY This returns the value of the PROPERTY property stored in the property list PLIST. For example, (plist-get '(foo 4) 'foo) => 4 - Function: plist-put PLIST PROPERTY VALUE This stores VALUE as the value of the PROPERTY property in the property list PLIST. It may modify PLIST destructively, or it may construct a new list structure without altering the old. The function returns the modified property list, so you can store that back in the place where you got PLIST. For example, (setq my-plist '(bar t foo 4)) => (bar t foo 4) (setq my-plist (plist-put my-plist 'foo 69)) => (bar t foo 69) (setq my-plist (plist-put my-plist 'quux '(a))) => (bar t foo 69 quux (a)) You could define `put' in terms of `plist-put' as follows: (defun put (symbol prop value) (setplist symbol (plist-put (symbol-plist symbol) prop value))) Evaluation ********** The "evaluation" of expressions in Emacs Lisp is performed by the "Lisp interpreter"--a program that receives a Lisp object as input and computes its "value as an expression". How it does this depends on the data type of the object, according to rules described in this chapter. The interpreter runs automatically to evaluate portions of your program, but can also be called explicitly via the Lisp primitive function `eval'. Introduction to Evaluation ========================== The Lisp interpreter, or evaluator, is the program that computes the value of an expression that is given to it. When a function written in Lisp is called, the evaluator computes the value of the function by evaluating the expressions in the function body. Thus, running any Lisp program really means running the Lisp interpreter. How the evaluator handles an object depends primarily on the data type of the object. A Lisp object that is intended for evaluation is called an "expression" or a "form". The fact that expressions are data objects and not merely text is one of the fundamental differences between Lisp-like languages and typical programming languages. Any object can be evaluated, but in practice only numbers, symbols, lists and strings are evaluated very often. It is very common to read a Lisp expression and then evaluate the expression, but reading and evaluation are separate activities, and either can be performed alone. Reading per se does not evaluate anything; it converts the printed representation of a Lisp object to the object itself. It is up to the caller of `read' whether this object is a form to be evaluated, or serves some entirely different purpose. *Note Input Functions::. Do not confuse evaluation with command key interpretation. The editor command loop translates keyboard input into a command (an interactively callable function) using the active keymaps, and then uses `call-interactively' to invoke the command. The execution of the command itself involves evaluation if the command is written in Lisp, but that is not a part of command key interpretation itself. *Note Command Loop::. Evaluation is a recursive process. That is, evaluation of a form may call `eval' to evaluate parts of the form. For example, evaluation of a function call first evaluates each argument of the function call, and then evaluates each form in the function body. Consider evaluation of the form `(car x)': the subform `x' must first be evaluated recursively, so that its value can be passed as an argument to the function `car'. Evaluation of a function call ultimately calls the function specified in it. *Note Functions::. The execution of the function may itself work by evaluating the function definition; or the function may be a Lisp primitive implemented in C, or it may be a byte-compiled function (*note Byte Compilation::.). The evaluation of forms takes place in a context called the "environment", which consists of the current values and bindings of all Lisp variables.(1) Whenever a form refers to a variable without creating a new binding for it, the value of the variable's binding in the current environment is used. *Note Variables::. Evaluation of a form may create new environments for recursive evaluation by binding variables (*note Local Variables::.). These environments are temporary and vanish by the time evaluation of the form is complete. The form may also make changes that persist; these changes are called "side effects". An example of a form that produces side effects is `(setq foo 1)'. The details of what evaluation means for each kind of form are described below (*note Forms::.). ---------- Footnotes ---------- (1) This definition of "environment" is specifically not intended to include all the data that can affect the result of a program. Kinds of Forms ============== A Lisp object that is intended to be evaluated is called a "form". How Emacs evaluates a form depends on its data type. Emacs has three different kinds of form that are evaluated differently: symbols, lists, and "all other types". This section describes all three kinds, one by one, starting with the "all other types" which are self-evaluating forms. Self-Evaluating Forms --------------------- A "self-evaluating form" is any form that is not a list or symbol. Self-evaluating forms evaluate to themselves: the result of evaluation is the same object that was evaluated. Thus, the number 25 evaluates to 25, and the string `"foo"' evaluates to the string `"foo"'. Likewise, evaluation of a vector does not cause evaluation of the elements of the vector--it returns the same vector with its contents unchanged. '123 ; A number, shown without evaluation. => 123 123 ; Evaluated as usual--result is the same. => 123 (eval '123) ; Evaluated "by hand"--result is the same. => 123 (eval (eval '123)) ; Evaluating twice changes nothing. => 123 It is common to write numbers, characters, strings, and even vectors in Lisp code, taking advantage of the fact that they self-evaluate. However, it is quite unusual to do this for types that lack a read syntax, because there's no way to write them textually. It is possible to construct Lisp expressions containing these types by means of a Lisp program. Here is an example: ;; Build an expression containing a buffer object. (setq print-exp (list 'print (current-buffer))) => (print #) ;; Evaluate it. (eval print-exp) -| # => # Symbol Forms ------------ When a symbol is evaluated, it is treated as a variable. The result is the variable's value, if it has one. If it has none (if its value cell is void), an error is signaled. For more information on the use of variables, see *Note Variables::. In the following example, we set the value of a symbol with `setq'. Then we evaluate the symbol, and get back the value that `setq' stored. (setq a 123) => 123 (eval 'a) => 123 a => 123 The symbols `nil' and `t' are treated specially, so that the value of `nil' is always `nil', and the value of `t' is always `t'; you cannot set or bind them to any other values. Thus, these two symbols act like self-evaluating forms, even though `eval' treats them like any other symbol. A symbol whose name starts with `:' also self-evaluates in the same way; likewise, its value ordinarily cannot be changed. *Note Constant Variables::. Classification of List Forms ---------------------------- A form that is a nonempty list is either a function call, a macro call, or a special form, according to its first element. These three kinds of forms are evaluated in different ways, described below. The remaining list elements constitute the "arguments" for the function, macro, or special form. The first step in evaluating a nonempty list is to examine its first element. This element alone determines what kind of form the list is and how the rest of the list is to be processed. The first element is *not* evaluated, as it would be in some Lisp dialects such as Scheme. Symbol Function Indirection --------------------------- If the first element of the list is a symbol then evaluation examines the symbol's function cell, and uses its contents instead of the original symbol. If the contents are another symbol, this process, called "symbol function indirection", is repeated until it obtains a non-symbol. *Note Function Names::, for more information about using a symbol as a name for a function stored in the function cell of the symbol. One possible consequence of this process is an infinite loop, in the event that a symbol's function cell refers to the same symbol. Or a symbol may have a void function cell, in which case the subroutine `symbol-function' signals a `void-function' error. But if neither of these things happens, we eventually obtain a non-symbol, which ought to be a function or other suitable object. More precisely, we should now have a Lisp function (a lambda expression), a byte-code function, a primitive function, a Lisp macro, a special form, or an autoload object. Each of these types is a case described in one of the following sections. If the object is not one of these types, the error `invalid-function' is signaled. The following example illustrates the symbol indirection process. We use `fset' to set the function cell of a symbol and `symbol-function' to get the function cell contents (*note Function Cells::.). Specifically, we store the symbol `car' into the function cell of `first', and the symbol `first' into the function cell of `erste'. ;; Build this function cell linkage: ;; ------------- ----- ------- ------- ;; | # | <-- | car | <-- | first | <-- | erste | ;; ------------- ----- ------- ------- (symbol-function 'car) => # (fset 'first 'car) => car (fset 'erste 'first) => first (erste '(1 2 3)) ; Call the function referenced by `erste'. => 1 By contrast, the following example calls a function without any symbol function indirection, because the first element is an anonymous Lisp function, not a symbol. ((lambda (arg) (erste arg)) '(1 2 3)) => 1 Executing the function itself evaluates its body; this does involve symbol function indirection when calling `erste'. The built-in function `indirect-function' provides an easy way to perform symbol function indirection explicitly. - Function: indirect-function FUNCTION This function returns the meaning of FUNCTION as a function. If FUNCTION is a symbol, then it finds FUNCTION's function definition and starts over with that value. If FUNCTION is not a symbol, then it returns FUNCTION itself. Here is how you could define `indirect-function' in Lisp: (defun indirect-function (function) (if (symbolp function) (indirect-function (symbol-function function)) function)) Evaluation of Function Forms ---------------------------- If the first element of a list being evaluated is a Lisp function object, byte-code object or primitive function object, then that list is a "function call". For example, here is a call to the function `+': (+ 1 x) The first step in evaluating a function call is to evaluate the remaining elements of the list from left to right. The results are the actual argument values, one value for each list element. The next step is to call the function with this list of arguments, effectively using the function `apply' (*note Calling Functions::.). If the function is written in Lisp, the arguments are used to bind the argument variables of the function (*note Lambda Expressions::.); then the forms in the function body are evaluated in order, and the value of the last body form becomes the value of the function call. Lisp Macro Evaluation --------------------- If the first element of a list being evaluated is a macro object, then the list is a "macro call". When a macro call is evaluated, the elements of the rest of the list are *not* initially evaluated. Instead, these elements themselves are used as the arguments of the macro. The macro definition computes a replacement form, called the "expansion" of the macro, to be evaluated in place of the original form. The expansion may be any sort of form: a self-evaluating constant, a symbol, or a list. If the expansion is itself a macro call, this process of expansion repeats until some other sort of form results. Ordinary evaluation of a macro call finishes by evaluating the expansion. However, the macro expansion is not necessarily evaluated right away, or at all, because other programs also expand macro calls, and they may or may not evaluate the expansions. Normally, the argument expressions are not evaluated as part of computing the macro expansion, but instead appear as part of the expansion, so they are computed when the expansion is evaluated. For example, given a macro defined as follows: (defmacro cadr (x) (list 'car (list 'cdr x))) an expression such as `(cadr (assq 'handler list))' is a macro call, and its expansion is: (car (cdr (assq 'handler list))) Note that the argument `(assq 'handler list)' appears in the expansion. *Note Macros::, for a complete description of Emacs Lisp macros. Special Forms ------------- A "special form" is a primitive function specially marked so that its arguments are not all evaluated. Most special forms define control structures or perform variable bindings--things which functions cannot do. Each special form has its own rules for which arguments are evaluated and which are used without evaluation. Whether a particular argument is evaluated may depend on the results of evaluating other arguments. Here is a list, in alphabetical order, of all of the special forms in Emacs Lisp with a reference to where each is described. `and' *note Combining Conditions::. `catch' *note Catch and Throw::. `cond' *note Conditionals::. `condition-case' *note Handling Errors::. `defconst' *note Defining Variables::. `defmacro' *note Defining Macros::. `defun' *note Defining Functions::. `defvar' *note Defining Variables::. `function' *note Anonymous Functions::. `if' *note Conditionals::. `interactive' *note Interactive Call::. `let' `let*' *note Local Variables::. `or' *note Combining Conditions::. `prog1' `prog2' `progn' *note Sequencing::. `quote' *note Quoting::. `save-current-buffer' *note Current Buffer::. `save-excursion' *note Excursions::. `save-restriction' *note Narrowing::. `save-window-excursion' *note Window Configurations::. `setq' *note Setting Variables::. `setq-default' *note Creating Buffer-Local::. `track-mouse' *note Mouse Tracking::. `unwind-protect' *note Nonlocal Exits::. `while' *note Iteration::. `with-output-to-temp-buffer' *note Temporary Displays::. Common Lisp note: Here are some comparisons of special forms in GNU Emacs Lisp and Common Lisp. `setq', `if', and `catch' are special forms in both Emacs Lisp and Common Lisp. `defun' is a special form in Emacs Lisp, but a macro in Common Lisp. `save-excursion' is a special form in Emacs Lisp, but doesn't exist in Common Lisp. `throw' is a special form in Common Lisp (because it must be able to throw multiple values), but it is a function in Emacs Lisp (which doesn't have multiple values). Autoloading ----------- The "autoload" feature allows you to call a function or macro whose function definition has not yet been loaded into Emacs. It specifies which file contains the definition. When an autoload object appears as a symbol's function definition, calling that symbol as a function automatically loads the specified file; then it calls the real definition loaded from that file. *Note Autoload::. Quoting ======= The special form `quote' returns its single argument, as written, without evaluating it. This provides a way to include constant symbols and lists, which are not self-evaluating objects, in a program. (It is not necessary to quote self-evaluating objects such as numbers, strings, and vectors.) - Special Form: quote OBJECT This special form returns OBJECT, without evaluating it. Because `quote' is used so often in programs, Lisp provides a convenient read syntax for it. An apostrophe character (`'') followed by a Lisp object (in read syntax) expands to a list whose first element is `quote', and whose second element is the object. Thus, the read syntax `'x' is an abbreviation for `(quote x)'. Here are some examples of expressions that use `quote': (quote (+ 1 2)) => (+ 1 2) (quote foo) => foo 'foo => foo ''foo => (quote foo) '(quote foo) => (quote foo) ['foo] => [(quote foo)] Other quoting constructs include `function' (*note Anonymous Functions::.), which causes an anonymous lambda expression written in Lisp to be compiled, and ``' (*note Backquote::.), which is used to quote only part of a list, while computing and substituting other parts. Eval ==== Most often, forms are evaluated automatically, by virtue of their occurrence in a program being run. On rare occasions, you may need to write code that evaluates a form that is computed at run time, such as after reading a form from text being edited or getting one from a property list. On these occasions, use the `eval' function. The functions and variables described in this section evaluate forms, specify limits to the evaluation process, or record recently returned values. Loading a file also does evaluation (*note Loading::.). *Note:* it is generally cleaner and more flexible to store a function in a data structure, and call it with `funcall' or `apply', than to store an expression in the data structure and evaluate it. Using functions provides the ability to pass information to them as arguments. - Function: eval FORM This is the basic function evaluating an expression. It evaluates FORM in the current environment and returns the result. How the evaluation proceeds depends on the type of the object (*note Forms::.). Since `eval' is a function, the argument expression that appears in a call to `eval' is evaluated twice: once as preparation before `eval' is called, and again by the `eval' function itself. Here is an example: (setq foo 'bar) => bar (setq bar 'baz) => baz ;; Here `eval' receives argument `foo' (eval 'foo) => bar ;; Here `eval' receives argument `bar', which is the value of `foo' (eval foo) => baz The number of currently active calls to `eval' is limited to `max-lisp-eval-depth' (see below). - Command: eval-region START END &optional STREAM READ-FUNCTION This function evaluates the forms in the current buffer in the region defined by the positions START and END. It reads forms from the region and calls `eval' on them until the end of the region is reached, or until an error is signaled and not handled. If STREAM is non-`nil', the values that result from evaluating the expressions in the region are printed using STREAM. *Note Output Streams::. If READ-FUNCTION is non-`nil', it should be a function, which is used instead of `read' to read expressions one by one. This function is called with one argument, the stream for reading input. You can also use the variable `load-read-function' (*note How Programs Do Loading::.) to specify this function, but it is more robust to use the READ-FUNCTION argument. `eval-region' always returns `nil'. - Command: eval-current-buffer &optional STREAM This is like `eval-region' except that it operates on the whole buffer. - Variable: max-lisp-eval-depth This variable defines the maximum depth allowed in calls to `eval', `apply', and `funcall' before an error is signaled (with error message `"Lisp nesting exceeds max-lisp-eval-depth"'). This limit, with the associated error when it is exceeded, is one way that Lisp avoids infinite recursion on an ill-defined function. The depth limit counts internal uses of `eval', `apply', and `funcall', such as for calling the functions mentioned in Lisp expressions, and recursive evaluation of function call arguments and function body forms, as well as explicit calls in Lisp code. The default value of this variable is 300. If you set it to a value less than 100, Lisp will reset it to 100 if the given value is reached. Entry to the Lisp debugger increases the value, if there is little room left, to make sure the debugger itself has room to execute. `max-specpdl-size' provides another limit on nesting. *Note Local Variables::. - Variable: values The value of this variable is a list of the values returned by all the expressions that were read, evaluated, and printed from buffers (including the minibuffer) by the standard Emacs commands which do this. The elements are ordered most recent first. (setq x 1) => 1 (list 'A (1+ 2) auto-save-default) => (A 3 t) values => ((A 3 t) 1 ...) This variable is useful for referring back to values of forms recently evaluated. It is generally a bad idea to print the value of `values' itself, since this may be very long. Instead, examine particular elements, like this: ;; Refer to the most recent evaluation result. (nth 0 values) => (A 3 t) ;; That put a new element on, ;; so all elements move back one. (nth 1 values) => (A 3 t) ;; This gets the element that was next-to-most-recent ;; before this example. (nth 3 values) => 1 Control Structures ****************** A Lisp program consists of expressions or "forms" (*note Forms::.). We control the order of execution of the forms by enclosing them in "control structures". Control structures are special forms which control when, whether, or how many times to execute the forms they contain. The simplest order of execution is sequential execution: first form A, then form B, and so on. This is what happens when you write several forms in succession in the body of a function, or at top level in a file of Lisp code--the forms are executed in the order written. We call this "textual order". For example, if a function body consists of two forms A and B, evaluation of the function evaluates first A and then B, and the function's value is the value of B. Explicit control structures make possible an order of execution other than sequential. Emacs Lisp provides several kinds of control structure, including other varieties of sequencing, conditionals, iteration, and (controlled) jumps--all discussed below. The built-in control structures are special forms since their subforms are not necessarily evaluated or not evaluated sequentially. You can use macros to define your own control structure constructs (*note Macros::.). Sequencing ========== Evaluating forms in the order they appear is the most common way control passes from one form to another. In some contexts, such as in a function body, this happens automatically. Elsewhere you must use a control structure construct to do this: `progn', the simplest control construct of Lisp. A `progn' special form looks like this: (progn A B C ...) and it says to execute the forms A, B, C and so on, in that order. These forms are called the body of the `progn' form. The value of the last form in the body becomes the value of the entire `progn'. In the early days of Lisp, `progn' was the only way to execute two or more forms in succession and use the value of the last of them. But programmers found they often needed to use a `progn' in the body of a function, where (at that time) only one form was allowed. So the body of a function was made into an "implicit `progn'": several forms are allowed just as in the body of an actual `progn'. Many other control structures likewise contain an implicit `progn'. As a result, `progn' is not used as often as it used to be. It is needed now most often inside an `unwind-protect', `and', `or', or in the THEN-part of an `if'. - Special Form: progn FORMS... This special form evaluates all of the FORMS, in textual order, returning the result of the final form. (progn (print "The first form") (print "The second form") (print "The third form")) -| "The first form" -| "The second form" -| "The third form" => "The third form" Two other control constructs likewise evaluate a series of forms but return a different value: - Special Form: prog1 FORM1 FORMS... This special form evaluates FORM1 and all of the FORMS, in textual order, returning the result of FORM1. (prog1 (print "The first form") (print "The second form") (print "The third form")) -| "The first form" -| "The second form" -| "The third form" => "The first form" Here is a way to remove the first element from a list in the variable `x', then return the value of that former element: (prog1 (car x) (setq x (cdr x))) - Special Form: prog2 FORM1 FORM2 FORMS... This special form evaluates FORM1, FORM2, and all of the following FORMS, in textual order, returning the result of FORM2. (prog2 (print "The first form") (print "The second form") (print "The third form")) -| "The first form" -| "The second form" -| "The third form" => "The second form" Conditionals ============ Conditional control structures choose among alternatives. Emacs Lisp has four conditional forms: `if', which is much the same as in other languages; `when' and `unless', which are variants of `if'; and `cond', which is a generalized case statement. - Special Form: if CONDITION THEN-FORM ELSE-FORMS... `if' chooses between the THEN-FORM and the ELSE-FORMS based on the value of CONDITION. If the evaluated CONDITION is non-`nil', THEN-FORM is evaluated and the result returned. Otherwise, the ELSE-FORMS are evaluated in textual order, and the value of the last one is returned. (The ELSE part of `if' is an example of an implicit `progn'. *Note Sequencing::.) If CONDITION has the value `nil', and no ELSE-FORMS are given, `if' returns `nil'. `if' is a special form because the branch that is not selected is never evaluated--it is ignored. Thus, in the example below, `true' is not printed because `print' is never called. (if nil (print 'true) 'very-false) => very-false - Macro: when CONDITION THEN-FORMS... This is a variant of `if' where there are no ELSE-FORMS, and possibly several THEN-FORMS. In particular, (when CONDITION A B C) is entirely equivalent to (if CONDITION (progn A B C) nil) - Macro: unless CONDITION FORMS... This is a variant of `if' where there is no THEN-FORM: (unless CONDITION A B C) is entirely equivalent to (if CONDITION nil A B C) - Special Form: cond CLAUSE... `cond' chooses among an arbitrary number of alternatives. Each CLAUSE in the `cond' must be a list. The CAR of this list is the CONDITION; the remaining elements, if any, the BODY-FORMS. Thus, a clause looks like this: (CONDITION BODY-FORMS...) `cond' tries the clauses in textual order, by evaluating the CONDITION of each clause. If the value of CONDITION is non-`nil', the clause "succeeds"; then `cond' evaluates its BODY-FORMS, and the value of the last of BODY-FORMS becomes the value of the `cond'. The remaining clauses are ignored. If the value of CONDITION is `nil', the clause "fails", so the `cond' moves on to the following clause, trying its CONDITION. If every CONDITION evaluates to `nil', so that every clause fails, `cond' returns `nil'. A clause may also look like this: (CONDITION) Then, if CONDITION is non-`nil' when tested, the value of CONDITION becomes the value of the `cond' form. The following example has four clauses, which test for the cases where the value of `x' is a number, string, buffer and symbol, respectively: (cond ((numberp x) x) ((stringp x) x) ((bufferp x) (setq temporary-hack x) ; multiple body-forms (buffer-name x)) ; in one clause ((symbolp x) (symbol-value x))) Often we want to execute the last clause whenever none of the previous clauses was successful. To do this, we use `t' as the CONDITION of the last clause, like this: `(t BODY-FORMS)'. The form `t' evaluates to `t', which is never `nil', so this clause never fails, provided the `cond' gets to it at all. For example, (cond ((eq a 'hack) 'foo) (t "default")) => "default" This expression is a `cond' which returns `foo' if the value of `a' is `hack', and returns the string `"default"' otherwise. Any conditional construct can be expressed with `cond' or with `if'. Therefore, the choice between them is a matter of style. For example: (if A B C) == (cond (A B) (t C)) Constructs for Combining Conditions =================================== This section describes three constructs that are often used together with `if' and `cond' to express complicated conditions. The constructs `and' and `or' can also be used individually as kinds of multiple conditional constructs. - Function: not CONDITION This function tests for the falsehood of CONDITION. It returns `t' if CONDITION is `nil', and `nil' otherwise. The function `not' is identical to `null', and we recommend using the name `null' if you are testing for an empty list. - Special Form: and CONDITIONS... The `and' special form tests whether all the CONDITIONS are true. It works by evaluating the CONDITIONS one by one in the order written. If any of the CONDITIONS evaluates to `nil', then the result of the `and' must be `nil' regardless of the remaining CONDITIONS; so `and' returns right away, ignoring the remaining CONDITIONS. If all the CONDITIONS turn out non-`nil', then the value of the last of them becomes the value of the `and' form. Here is an example. The first condition returns the integer 1, which is not `nil'. Similarly, the second condition returns the integer 2, which is not `nil'. The third condition is `nil', so the remaining condition is never evaluated. (and (print 1) (print 2) nil (print 3)) -| 1 -| 2 => nil Here is a more realistic example of using `and': (if (and (consp foo) (eq (car foo) 'x)) (message "foo is a list starting with x")) Note that `(car foo)' is not executed if `(consp foo)' returns `nil', thus avoiding an error. `and' can be expressed in terms of either `if' or `cond'. For example: (and ARG1 ARG2 ARG3) == (if ARG1 (if ARG2 ARG3)) == (cond (ARG1 (cond (ARG2 ARG3)))) - Special Form: or CONDITIONS... The `or' special form tests whether at least one of the CONDITIONS is true. It works by evaluating all the CONDITIONS one by one in the order written. If any of the CONDITIONS evaluates to a non-`nil' value, then the result of the `or' must be non-`nil'; so `or' returns right away, ignoring the remaining CONDITIONS. The value it returns is the non-`nil' value of the condition just evaluated. If all the CONDITIONS turn out `nil', then the `or' expression returns `nil'. For example, this expression tests whether `x' is either 0 or `nil': (or (eq x nil) (eq x 0)) Like the `and' construct, `or' can be written in terms of `cond'. For example: (or ARG1 ARG2 ARG3) == (cond (ARG1) (ARG2) (ARG3)) You could almost write `or' in terms of `if', but not quite: (if ARG1 ARG1 (if ARG2 ARG2 ARG3)) This is not completely equivalent because it can evaluate ARG1 or ARG2 twice. By contrast, `(or ARG1 ARG2 ARG3)' never evaluates any argument more than once. Iteration ========= Iteration means executing part of a program repetitively. For example, you might want to repeat some computation once for each element of a list, or once for each integer from 0 to N. You can do this in Emacs Lisp with the special form `while': - Special Form: while CONDITION FORMS... `while' first evaluates CONDITION. If the result is non-`nil', it evaluates FORMS in textual order. Then it reevaluates CONDITION, and if the result is non-`nil', it evaluates FORMS again. This process repeats until CONDITION evaluates to `nil'. There is no limit on the number of iterations that may occur. The loop will continue until either CONDITION evaluates to `nil' or until an error or `throw' jumps out of it (*note Nonlocal Exits::.). The value of a `while' form is always `nil'. (setq num 0) => 0 (while (< num 4) (princ (format "Iteration %d." num)) (setq num (1+ num))) -| Iteration 0. -| Iteration 1. -| Iteration 2. -| Iteration 3. => nil If you would like to execute something on each iteration before the end-test, put it together with the end-test in a `progn' as the first argument of `while', as shown here: (while (progn (forward-line 1) (not (looking-at "^$")))) This moves forward one line and continues moving by lines until it reaches an empty line. It is peculiar in that the `while' has no body, just the end test (which also does the real work of moving point). Nonlocal Exits ============== A "nonlocal exit" is a transfer of control from one point in a program to another remote point. Nonlocal exits can occur in Emacs Lisp as a result of errors; you can also use them under explicit control. Nonlocal exits unbind all variable bindings made by the constructs being exited. Explicit Nonlocal Exits: `catch' and `throw' -------------------------------------------- Most control constructs affect only the flow of control within the construct itself. The function `throw' is the exception to this rule of normal program execution: it performs a nonlocal exit on request. (There are other exceptions, but they are for error handling only.) `throw' is used inside a `catch', and jumps back to that `catch'. For example: (defun foo-outer () (catch 'foo (foo-inner))) (defun foo-inner () ... (if x (throw 'foo t)) ...) The `throw' form, if executed, transfers control straight back to the corresponding `catch', which returns immediately. The code following the `throw' is not executed. The second argument of `throw' is used as the return value of the `catch'. The function `throw' finds the matching `catch' based on the first argument: it searches for a `catch' whose first argument is `eq' to the one specified in the `throw'. If there is more than one applicable `catch', the innermost one takes precedence. Thus, in the above example, the `throw' specifies `foo', and the `catch' in `foo-outer' specifies the same symbol, so that `catch' is the applicable one (assuming there is no other matching `catch' in between). Executing `throw' exits all Lisp constructs up to the matching `catch', including function calls. When binding constructs such as `let' or function calls are exited in this way, the bindings are unbound, just as they are when these constructs exit normally (*note Local Variables::.). Likewise, `throw' restores the buffer and position saved by `save-excursion' (*note Excursions::.), and the narrowing status saved by `save-restriction' and the window selection saved by `save-window-excursion' (*note Window Configurations::.). It also runs any cleanups established with the `unwind-protect' special form when it exits that form (*note Cleanups::.). The `throw' need not appear lexically within the `catch' that it jumps to. It can equally well be called from another function called within the `catch'. As long as the `throw' takes place chronologically after entry to the `catch', and chronologically before exit from it, it has access to that `catch'. This is why `throw' can be used in commands such as `exit-recursive-edit' that throw back to the editor command loop (*note Recursive Editing::.). Common Lisp note: Most other versions of Lisp, including Common Lisp, have several ways of transferring control nonsequentially: `return', `return-from', and `go', for example. Emacs Lisp has only `throw'. - Special Form: catch TAG BODY... `catch' establishes a return point for the `throw' function. The return point is distinguished from other such return points by TAG, which may be any Lisp object except `nil'. The argument TAG is evaluated normally before the return point is established. With the return point in effect, `catch' evaluates the forms of the BODY in textual order. If the forms execute normally, without error or nonlocal exit, the value of the last body form is returned from the `catch'. If a `throw' is done within BODY specifying the same value TAG, the `catch' exits immediately; the value it returns is whatever was specified as the second argument of `throw'. - Function: throw TAG VALUE The purpose of `throw' is to return from a return point previously established with `catch'. The argument TAG is used to choose among the various existing return points; it must be `eq' to the value specified in the `catch'. If multiple return points match TAG, the innermost one is used. The argument VALUE is used as the value to return from that `catch'. If no return point is in effect with tag TAG, then a `no-catch' error is signaled with data `(TAG VALUE)'. Examples of `catch' and `throw' ------------------------------- One way to use `catch' and `throw' is to exit from a doubly nested loop. (In most languages, this would be done with a "go to".) Here we compute `(foo I J)' for I and J varying from 0 to 9: (defun search-foo () (catch 'loop (let ((i 0)) (while (< i 10) (let ((j 0)) (while (< j 10) (if (foo i j) (throw 'loop (list i j))) (setq j (1+ j)))) (setq i (1+ i)))))) If `foo' ever returns non-`nil', we stop immediately and return a list of I and J. If `foo' always returns `nil', the `catch' returns normally, and the value is `nil', since that is the result of the `while'. Here are two tricky examples, slightly different, showing two return points at once. First, two return points with the same tag, `hack': (defun catch2 (tag) (catch tag (throw 'hack 'yes))) => catch2 (catch 'hack (print (catch2 'hack)) 'no) -| yes => no Since both return points have tags that match the `throw', it goes to the inner one, the one established in `catch2'. Therefore, `catch2' returns normally with value `yes', and this value is printed. Finally the second body form in the outer `catch', which is `'no', is evaluated and returned from the outer `catch'. Now let's change the argument given to `catch2': (defun catch2 (tag) (catch tag (throw 'hack 'yes))) => catch2 (catch 'hack (print (catch2 'quux)) 'no) => yes We still have two return points, but this time only the outer one has the tag `hack'; the inner one has the tag `quux' instead. Therefore, `throw' makes the outer `catch' return the value `yes'. The function `print' is never called, and the body-form `'no' is never evaluated. Errors ------ When Emacs Lisp attempts to evaluate a form that, for some reason, cannot be evaluated, it "signals" an "error". When an error is signaled, Emacs's default reaction is to print an error message and terminate execution of the current command. This is the right thing to do in most cases, such as if you type `C-f' at the end of the buffer. In complicated programs, simple termination may not be what you want. For example, the program may have made temporary changes in data structures, or created temporary buffers that should be deleted before the program is finished. In such cases, you would use `unwind-protect' to establish "cleanup expressions" to be evaluated in case of error. (*Note Cleanups::.) Occasionally, you may wish the program to continue execution despite an error in a subroutine. In these cases, you would use `condition-case' to establish "error handlers" to recover control in case of error. Resist the temptation to use error handling to transfer control from one part of the program to another; use `catch' and `throw' instead. *Note Catch and Throw::. How to Signal an Error ...................... Most errors are signaled "automatically" within Lisp primitives which you call for other purposes, such as if you try to take the CAR of an integer or move forward a character at the end of the buffer; you can also signal errors explicitly with the functions `error' and `signal'. Quitting, which happens when the user types `C-g', is not considered an error, but it is handled almost like an error. *Note Quitting::. - Function: error FORMAT-STRING &rest ARGS This function signals an error with an error message constructed by applying `format' (*note String Conversion::.) to FORMAT-STRING and ARGS. These examples show typical uses of `error': (error "That is an error -- try something else") error--> That is an error -- try something else (error "You have committed %d errors" 10) error--> You have committed 10 errors `error' works by calling `signal' with two arguments: the error symbol `error', and a list containing the string returned by `format'. *Warning:* If you want to use your own string as an error message verbatim, don't just write `(error STRING)'. If STRING contains `%', it will be interpreted as a format specifier, with undesirable results. Instead, use `(error "%s" STRING)'. - Function: signal ERROR-SYMBOL DATA This function signals an error named by ERROR-SYMBOL. The argument DATA is a list of additional Lisp objects relevant to the circumstances of the error. The argument ERROR-SYMBOL must be an "error symbol"--a symbol bearing a property `error-conditions' whose value is a list of condition names. This is how Emacs Lisp classifies different sorts of errors. The number and significance of the objects in DATA depends on ERROR-SYMBOL. For example, with a `wrong-type-arg' error, there should be two objects in the list: a predicate that describes the type that was expected, and the object that failed to fit that type. *Note Error Symbols::, for a description of error symbols. Both ERROR-SYMBOL and DATA are available to any error handlers that handle the error: `condition-case' binds a local variable to a list of the form `(ERROR-SYMBOL . DATA)' (*note Handling Errors::.). If the error is not handled, these two values are used in printing the error message. The function `signal' never returns (though in older Emacs versions it could sometimes return). (signal 'wrong-number-of-arguments '(x y)) error--> Wrong number of arguments: x, y (signal 'no-such-error '("My unknown error condition")) error--> peculiar error: "My unknown error condition" Common Lisp note: Emacs Lisp has nothing like the Common Lisp concept of continuable errors. How Emacs Processes Errors .......................... When an error is signaled, `signal' searches for an active "handler" for the error. A handler is a sequence of Lisp expressions designated to be executed if an error happens in part of the Lisp program. If the error has an applicable handler, the handler is executed, and control resumes following the handler. The handler executes in the environment of the `condition-case' that established it; all functions called within that `condition-case' have already been exited, and the handler cannot return to them. If there is no applicable handler for the error, the current command is terminated and control returns to the editor command loop, because the command loop has an implicit handler for all kinds of errors. The command loop's handler uses the error symbol and associated data to print an error message. An error that has no explicit handler may call the Lisp debugger. The debugger is enabled if the variable `debug-on-error' (*note Error Debugging::.) is non-`nil'. Unlike error handlers, the debugger runs in the environment of the error, so that you can examine values of variables precisely as they were at the time of the error. Writing Code to Handle Errors ............................. The usual effect of signaling an error is to terminate the command that is running and return immediately to the Emacs editor command loop. You can arrange to trap errors occurring in a part of your program by establishing an error handler, with the special form `condition-case'. A simple example looks like this: (condition-case nil (delete-file filename) (error nil)) This deletes the file named FILENAME, catching any error and returning `nil' if an error occurs. The second argument of `condition-case' is called the "protected form". (In the example above, the protected form is a call to `delete-file'.) The error handlers go into effect when this form begins execution and are deactivated when this form returns. They remain in effect for all the intervening time. In particular, they are in effect during the execution of functions called by this form, in their subroutines, and so on. This is a good thing, since, strictly speaking, errors can be signaled only by Lisp primitives (including `signal' and `error') called by the protected form, not by the protected form itself. The arguments after the protected form are handlers. Each handler lists one or more "condition names" (which are symbols) to specify which errors it will handle. The error symbol specified when an error is signaled also defines a list of condition names. A handler applies to an error if they have any condition names in common. In the example above, there is one handler, and it specifies one condition name, `error', which covers all errors. The search for an applicable handler checks all the established handlers starting with the most recently established one. Thus, if two nested `condition-case' forms offer to handle the same error, the inner of the two will actually handle it. If an error is handled by some `condition-case' form, this ordinarily prevents the debugger from being run, even if `debug-on-error' says this error should invoke the debugger. *Note Error Debugging::. If you want to be able to debug errors that are caught by a `condition-case', set the variable `debug-on-signal' to a non-`nil' value. When an error is handled, control returns to the handler. Before this happens, Emacs unbinds all variable bindings made by binding constructs that are being exited and executes the cleanups of all `unwind-protect' forms that are exited. Once control arrives at the handler, the body of the handler is executed. After execution of the handler body, execution returns from the `condition-case' form. Because the protected form is exited completely before execution of the handler, the handler cannot resume execution at the point of the error, nor can it examine variable bindings that were made within the protected form. All it can do is clean up and proceed. The `condition-case' construct is often used to trap errors that are predictable, such as failure to open a file in a call to `insert-file-contents'. It is also used to trap errors that are totally unpredictable, such as when the program evaluates an expression read from the user. Error signaling and handling have some resemblance to `throw' and `catch', but they are entirely separate facilities. An error cannot be caught by a `catch', and a `throw' cannot be handled by an error handler (though using `throw' when there is no suitable `catch' signals an error that can be handled). - Special Form: condition-case VAR PROTECTED-FORM HANDLERS... This special form establishes the error handlers HANDLERS around the execution of PROTECTED-FORM. If PROTECTED-FORM executes without error, the value it returns becomes the value of the `condition-case' form; in this case, the `condition-case' has no effect. The `condition-case' form makes a difference when an error occurs during PROTECTED-FORM. Each of the HANDLERS is a list of the form `(CONDITIONS BODY...)'. Here CONDITIONS is an error condition name to be handled, or a list of condition names; BODY is one or more Lisp expressions to be executed when this handler handles an error. Here are examples of handlers: (error nil) (arith-error (message "Division by zero")) ((arith-error file-error) (message "Either division by zero or failure to open a file")) Each error that occurs has an "error symbol" that describes what kind of error it is. The `error-conditions' property of this symbol is a list of condition names (*note Error Symbols::.). Emacs searches all the active `condition-case' forms for a handler that specifies one or more of these condition names; the innermost matching `condition-case' handles the error. Within this `condition-case', the first applicable handler handles the error. After executing the body of the handler, the `condition-case' returns normally, using the value of the last form in the handler body as the overall value. The argument VAR is a variable. `condition-case' does not bind this variable when executing the PROTECTED-FORM, only when it handles an error. At that time, it binds VAR locally to an "error description", which is a list giving the particulars of the error. The error description has the form `(ERROR-SYMBOL . DATA)'. The handler can refer to this list to decide what to do. For example, if the error is for failure opening a file, the file name is the second element of DATA--the third element of the error description. If VAR is `nil', that means no variable is bound. Then the error symbol and associated data are not available to the handler. - Function: error-message-string ERROR-DESCRIPTION This function returns the error message string for a given error descriptor. It is useful if you want to handle an error by printing the usual error message for that error. Here is an example of using `condition-case' to handle the error that results from dividing by zero. The handler displays the error message (but without a beep), then returns a very large number. (defun safe-divide (dividend divisor) (condition-case err ;; Protected form. (/ dividend divisor) ;; The handler. (arith-error ; Condition. ;; Display the usual message for this error. (message "%s" (error-message-string err)) 1000000))) => safe-divide (safe-divide 5 0) -| Arithmetic error: (arith-error) => 1000000 The handler specifies condition name `arith-error' so that it will handle only division-by-zero errors. Other kinds of errors will not be handled, at least not by this `condition-case'. Thus, (safe-divide nil 3) error--> Wrong type argument: number-or-marker-p, nil Here is a `condition-case' that catches all kinds of errors, including those signaled with `error': (setq baz 34) => 34 (condition-case err (if (eq baz 35) t ;; This is a call to the function `error'. (error "Rats! The variable %s was %s, not 35" 'baz baz)) ;; This is the handler; it is not a form. (error (princ (format "The error was: %s" err)) 2)) -| The error was: (error "Rats! The variable baz was 34, not 35") => 2 Error Symbols and Condition Names ................................. When you signal an error, you specify an "error symbol" to specify the kind of error you have in mind. Each error has one and only one error symbol to categorize it. This is the finest classification of errors defined by the Emacs Lisp language. These narrow classifications are grouped into a hierarchy of wider classes called "error conditions", identified by "condition names". The narrowest such classes belong to the error symbols themselves: each error symbol is also a condition name. There are also condition names for more extensive classes, up to the condition name `error' which takes in all kinds of errors. Thus, each error has one or more condition names: `error', the error symbol if that is distinct from `error', and perhaps some intermediate classifications. In order for a symbol to be an error symbol, it must have an `error-conditions' property which gives a list of condition names. This list defines the conditions that this kind of error belongs to. (The error symbol itself, and the symbol `error', should always be members of this list.) Thus, the hierarchy of condition names is defined by the `error-conditions' properties of the error symbols. In addition to the `error-conditions' list, the error symbol should have an `error-message' property whose value is a string to be printed when that error is signaled but not handled. If the `error-message' property exists, but is not a string, the error message `peculiar error' is used. Here is how we define a new error symbol, `new-error': (put 'new-error 'error-conditions '(error my-own-errors new-error)) => (error my-own-errors new-error) (put 'new-error 'error-message "A new error") => "A new error" This error has three condition names: `new-error', the narrowest classification; `my-own-errors', which we imagine is a wider classification; and `error', which is the widest of all. The error string should start with a capital letter but it should not end with a period. This is for consistency with the rest of Emacs. Naturally, Emacs will never signal `new-error' on its own; only an explicit call to `signal' (*note Signaling Errors::.) in your code can do this: (signal 'new-error '(x y)) error--> A new error: x, y This error can be handled through any of the three condition names. This example handles `new-error' and any other errors in the class `my-own-errors': (condition-case foo (bar nil t) (my-own-errors nil)) The significant way that errors are classified is by their condition names--the names used to match errors with handlers. An error symbol serves only as a convenient way to specify the intended error message and list of condition names. It would be cumbersome to give `signal' a list of condition names rather than one error symbol. By contrast, using only error symbols without condition names would seriously decrease the power of `condition-case'. Condition names make it possible to categorize errors at various levels of generality when you write an error handler. Using error symbols alone would eliminate all but the narrowest level of classification. *Note Standard Errors::, for a list of all the standard error symbols and their conditions. Cleaning Up from Nonlocal Exits ------------------------------- The `unwind-protect' construct is essential whenever you temporarily put a data structure in an inconsistent state; it permits you to make the data consistent again in the event of an error or throw. - Special Form: unwind-protect BODY CLEANUP-FORMS... `unwind-protect' executes the BODY with a guarantee that the CLEANUP-FORMS will be evaluated if control leaves BODY, no matter how that happens. The BODY may complete normally, or execute a `throw' out of the `unwind-protect', or cause an error; in all cases, the CLEANUP-FORMS will be evaluated. If the BODY forms finish normally, `unwind-protect' returns the value of the last BODY form, after it evaluates the CLEANUP-FORMS. If the BODY forms do not finish, `unwind-protect' does not return any value in the normal sense. Only the BODY is actually protected by the `unwind-protect'. If any of the CLEANUP-FORMS themselves exits nonlocally (e.g., via a `throw' or an error), `unwind-protect' is *not* guaranteed to evaluate the rest of them. If the failure of one of the CLEANUP-FORMS has the potential to cause trouble, then protect it with another `unwind-protect' around that form. The number of currently active `unwind-protect' forms counts, together with the number of local variable bindings, against the limit `max-specpdl-size' (*note Local Variables::.). For example, here we make an invisible buffer for temporary use, and make sure to kill it before finishing: (save-excursion (let ((buffer (get-buffer-create " *temp*"))) (set-buffer buffer) (unwind-protect BODY (kill-buffer buffer)))) You might think that we could just as well write `(kill-buffer (current-buffer))' and dispense with the variable `buffer'. However, the way shown above is safer, if BODY happens to get an error after switching to a different buffer! (Alternatively, you could write another `save-excursion' around the body, to ensure that the temporary buffer becomes current again in time to kill it.) Emacs includes a standard macro called `with-temp-buffer' which expands into more or less the code shown above (*note Current Buffer::.). Several of the macros defined in this manual use `unwind-protect' in this way. Here is an actual example taken from the file `ftp.el'. It creates a process (*note Processes::.) to try to establish a connection to a remote machine. As the function `ftp-login' is highly susceptible to numerous problems that the writer of the function cannot anticipate, it is protected with a form that guarantees deletion of the process in the event of failure. Otherwise, Emacs might fill up with useless subprocesses. (let ((win nil)) (unwind-protect (progn (setq process (ftp-setup-buffer host file)) (if (setq win (ftp-login process host user password)) (message "Logged in") (error "Ftp login failed"))) (or win (and process (delete-process process))))) This example actually has a small bug: if the user types `C-g' to quit, and the quit happens immediately after the function `ftp-setup-buffer' returns but before the variable `process' is set, the process will not be killed. There is no easy way to fix this bug, but at least it is very unlikely. Variables ********* A "variable" is a name used in a program to stand for a value. Nearly all programming languages have variables of some sort. In the text of a Lisp program, variables are written using the syntax for symbols. In Lisp, unlike most programming languages, programs are represented primarily as Lisp objects and only secondarily as text. The Lisp objects used for variables are symbols: the symbol name is the variable name, and the variable's value is stored in the value cell of the symbol. The use of a symbol as a variable is independent of its use as a function name. *Note Symbol Components::. The Lisp objects that constitute a Lisp program determine the textual form of the program--it is simply the read syntax for those Lisp objects. This is why, for example, a variable in a textual Lisp program is written using the read syntax for the symbol that represents the variable. Global Variables ================ The simplest way to use a variable is "globally". This means that the variable has just one value at a time, and this value is in effect (at least for the moment) throughout the Lisp system. The value remains in effect until you specify a new one. When a new value replaces the old one, no trace of the old value remains in the variable. You specify a value for a symbol with `setq'. For example, (setq x '(a b)) gives the variable `x' the value `(a b)'. Note that `setq' does not evaluate its first argument, the name of the variable, but it does evaluate the second argument, the new value. Once the variable has a value, you can refer to it by using the symbol by itself as an expression. Thus, x => (a b) assuming the `setq' form shown above has already been executed. If you do set the same variable again, the new value replaces the old one: x => (a b) (setq x 4) => 4 x => 4 Variables That Never Change =========================== In Emacs Lisp, certain symbols normally evaluate to themselves. These include `nil' and `t', as well as any symbol whose name starts with `:'. These symbols cannot be rebound, nor can their values be changed. Any attempt to set or bind `nil' or `t' signals a `setting-constant' error. The same is true for a symbol whose name starts with `:', except that you are allowed to set such a symbol to itself. nil == 'nil => nil (setq nil 500) error--> Attempt to set constant symbol: nil - Variable: keyword-symbols-constant-flag If this variable is `nil', you are allowed to set and bind symbols whose names start with `:' as you wish. This is to make it possible to run old Lisp programs which do that. Local Variables =============== Global variables have values that last until explicitly superseded with new values. Sometimes it is useful to create variable values that exist temporarily--only until a certain part of the program finishes. These values are called "local", and the variables so used are called "local variables". For example, when a function is called, its argument variables receive new local values that last until the function exits. The `let' special form explicitly establishes new local values for specified variables; these last until exit from the `let' form. Establishing a local value saves away the previous value (or lack of one) of the variable. When the life span of the local value is over, the previous value is restored. In the mean time, we say that the previous value is "shadowed" and "not visible". Both global and local values may be shadowed (*note Scope::.). If you set a variable (such as with `setq') while it is local, this replaces the local value; it does not alter the global value, or previous local values, that are shadowed. To model this behavior, we speak of a "local binding" of the variable as well as a local value. The local binding is a conceptual place that holds a local value. Entry to a function, or a special form such as `let', creates the local binding; exit from the function or from the `let' removes the local binding. As long as the local binding lasts, the variable's value is stored within it. Use of `setq' or `set' while there is a local binding stores a different value into the local binding; it does not create a new binding. We also speak of the "global binding", which is where (conceptually) the global value is kept. A variable can have more than one local binding at a time (for example, if there are nested `let' forms that bind it). In such a case, the most recently created local binding that still exists is the "current binding" of the variable. (This rule is called "dynamic scoping"; see *Note Variable Scoping::.) If there are no local bindings, the variable's global binding is its current binding. We sometimes call the current binding the "most-local existing binding", for emphasis. Ordinary evaluation of a symbol always returns the value of its current binding. The special forms `let' and `let*' exist to create local bindings. - Special Form: let (BINDINGS...) FORMS... This special form binds variables according to BINDINGS and then evaluates all of the FORMS in textual order. The `let'-form returns the value of the last form in FORMS. Each of the BINDINGS is either (i) a symbol, in which case that symbol is bound to `nil'; or (ii) a list of the form `(SYMBOL VALUE-FORM)', in which case SYMBOL is bound to the result of evaluating VALUE-FORM. If VALUE-FORM is omitted, `nil' is used. All of the VALUE-FORMs in BINDINGS are evaluated in the order they appear and *before* binding any of the symbols to them. Here is an example of this: `Z' is bound to the old value of `Y', which is 2, not the new value of `Y', which is 1. (setq Y 2) => 2 (let ((Y 1) (Z Y)) (list Y Z)) => (1 2) - Special Form: let* (BINDINGS...) FORMS... This special form is like `let', but it binds each variable right after computing its local value, before computing the local value for the next variable. Therefore, an expression in BINDINGS can reasonably refer to the preceding symbols bound in this `let*' form. Compare the following example with the example above for `let'. (setq Y 2) => 2 (let* ((Y 1) (Z Y)) ; Use the just-established value of `Y'. (list Y Z)) => (1 1) Here is a complete list of the other facilities that create local bindings: * Function calls (*note Functions::.). * Macro calls (*note Macros::.). * `condition-case' (*note Errors::.). Variables can also have buffer-local bindings (*note Buffer-Local Variables::.) and frame-local bindings (*note Frame-Local Variables::.); a few variables have terminal-local bindings (*note Multiple Displays::.). These kinds of bindings work somewhat like ordinary local bindings, but they are localized depending on "where" you are in Emacs, rather than localized in time. - Variable: max-specpdl-size This variable defines the limit on the total number of local variable bindings and `unwind-protect' cleanups (*note Nonlocal Exits::.) that are allowed before signaling an error (with data `"Variable binding depth exceeds max-specpdl-size"'). This limit, with the associated error when it is exceeded, is one way that Lisp avoids infinite recursion on an ill-defined function. `max-lisp-eval-depth' provides another limit on depth of nesting. *Note Eval::. The default value is 600. Entry to the Lisp debugger increases the value, if there is little room left, to make sure the debugger itself has room to execute. When a Variable is "Void" ========================= If you have never given a symbol any value as a global variable, we say that that symbol's global value is "void". In other words, the symbol's value cell does not have any Lisp object in it. If you try to evaluate the symbol, you get a `void-variable' error rather than a value. Note that a value of `nil' is not the same as void. The symbol `nil' is a Lisp object and can be the value of a variable just as any other object can be; but it is *a value*. A void variable does not have any value. After you have given a variable a value, you can make it void once more using `makunbound'. - Function: makunbound SYMBOL This function makes the current variable binding of SYMBOL void. Subsequent attempts to use this symbol's value as a variable will signal the error `void-variable', unless and until you set it again. `makunbound' returns SYMBOL. (makunbound 'x) ; Make the global value of `x' void. => x x error--> Symbol's value as variable is void: x If SYMBOL is locally bound, `makunbound' affects the most local existing binding. This is the only way a symbol can have a void local binding, since all the constructs that create local bindings create them with values. In this case, the voidness lasts at most as long as the binding does; when the binding is removed due to exit from the construct that made it, the previous local or global binding is reexposed as usual, and the variable is no longer void unless the newly reexposed binding was void all along. (setq x 1) ; Put a value in the global binding. => 1 (let ((x 2)) ; Locally bind it. (makunbound 'x) ; Void the local binding. x) error--> Symbol's value as variable is void: x x ; The global binding is unchanged. => 1 (let ((x 2)) ; Locally bind it. (let ((x 3)) ; And again. (makunbound 'x) ; Void the innermost-local binding. x)) ; And refer: it's void. error--> Symbol's value as variable is void: x (let ((x 2)) (let ((x 3)) (makunbound 'x)) ; Void inner binding, then remove it. x) ; Now outer `let' binding is visible. => 2 A variable that has been made void with `makunbound' is indistinguishable from one that has never received a value and has always been void. You can use the function `boundp' to test whether a variable is currently void. - Function: boundp VARIABLE `boundp' returns `t' if VARIABLE (a symbol) is not void; more precisely, if its current binding is not void. It returns `nil' otherwise. (boundp 'abracadabra) ; Starts out void. => nil (let ((abracadabra 5)) ; Locally bind it. (boundp 'abracadabra)) => t (boundp 'abracadabra) ; Still globally void. => nil (setq abracadabra 5) ; Make it globally nonvoid. => 5 (boundp 'abracadabra) => t Defining Global Variables ========================= You may announce your intention to use a symbol as a global variable with a "variable definition": a special form, either `defconst' or `defvar'. In Emacs Lisp, definitions serve three purposes. First, they inform people who read the code that certain symbols are *intended* to be used a certain way (as variables). Second, they inform the Lisp system of these things, supplying a value and documentation. Third, they provide information to utilities such as `etags' and `make-docfile', which create data bases of the functions and variables in a program. The difference between `defconst' and `defvar' is primarily a matter of intent, serving to inform human readers of whether the value should ever change. Emacs Lisp does not restrict the ways in which a variable can be used based on `defconst' or `defvar' declarations. However, it does make a difference for initialization: `defconst' unconditionally initializes the variable, while `defvar' initializes it only if it is void. - Special Form: defvar SYMBOL [VALUE [DOC-STRING]] This special form defines SYMBOL as a variable and can also initialize and document it. The definition informs a person reading your code that SYMBOL is used as a variable that might be set or changed. Note that SYMBOL is not evaluated; the symbol to be defined must appear explicitly in the `defvar'. If SYMBOL is void and VALUE is specified, `defvar' evaluates it and sets SYMBOL to the result. But if SYMBOL already has a value (i.e., it is not void), VALUE is not even evaluated, and SYMBOL's value remains unchanged. If VALUE is omitted, the value of SYMBOL is not changed in any case. If SYMBOL has a buffer-local binding in the current buffer, `defvar' operates on the default value, which is buffer-independent, not the current (buffer-local) binding. It sets the default value if the default value is void. *Note Buffer-Local Variables::. When you evaluate a top-level `defvar' form with `C-M-x' in Emacs Lisp mode (`eval-defun'), a special feature of `eval-defun' arranges to set the variable unconditionally, without testing whether its value is void. If the DOC-STRING argument appears, it specifies the documentation for the variable. (This opportunity to specify documentation is one of the main benefits of defining the variable.) The documentation is stored in the symbol's `variable-documentation' property. The Emacs help functions (*note Documentation::.) look for this property. If the first character of DOC-STRING is `*', it means that this variable is considered a user option. This lets users set the variable conveniently using the commands `set-variable' and `edit-options'. However, it is better to use `defcustom' instead of `defvar' for user option variables, so you can specify customization information. *Note Customization::. Here are some examples. This form defines `foo' but does not initialize it: (defvar foo) => foo This example initializes the value of `bar' to `23', and gives it a documentation string: (defvar bar 23 "The normal weight of a bar.") => bar The following form changes the documentation string for `bar', making it a user option, but does not change the value, since `bar' already has a value. (The addition `(1+ nil)' would get an error if it were evaluated, but since it is not evaluated, there is no error.) (defvar bar (1+ nil) "*The normal weight of a bar.") => bar bar => 23 Here is an equivalent expression for the `defvar' special form: (defvar SYMBOL VALUE DOC-STRING) == (progn (if (not (boundp 'SYMBOL)) (setq SYMBOL VALUE)) (if 'DOC-STRING (put 'SYMBOL 'variable-documentation 'DOC-STRING)) 'SYMBOL) The `defvar' form returns SYMBOL, but it is normally used at top level in a file where its value does not matter. - Special Form: defconst SYMBOL [VALUE [DOC-STRING]] This special form defines SYMBOL as a value and initializes it. It informs a person reading your code that SYMBOL has a standard global value, established here, that should not be changed by the user or by other programs. Note that SYMBOL is not evaluated; the symbol to be defined must appear explicitly in the `defconst'. `defconst' always evaluates VALUE, and sets the value of SYMBOL to the result if VALUE is given. If SYMBOL does have a buffer-local binding in the current buffer, `defconst' sets the default value, not the buffer-local value. (But you should not be making buffer-local bindings for a symbol that is defined with `defconst'.) Here, `pi' is a constant that presumably ought not to be changed by anyone (attempts by the Indiana State Legislature notwithstanding). As the second form illustrates, however, this is only advisory. (defconst pi 3.1415 "Pi to five places.") => pi (setq pi 3) => pi pi => 3 - Function: user-variable-p VARIABLE This function returns `t' if VARIABLE is a user option--a variable intended to be set by the user for customization--and `nil' otherwise. (Variables other than user options exist for the internal purposes of Lisp programs, and users need not know about them.) User option variables are distinguished from other variables by the first character of the `variable-documentation' property. If the property exists and is a string, and its first character is `*', then the variable is a user option. If a user option variable has a `variable-interactive' property, the `set-variable' command uses that value to control reading the new value for the variable. The property's value is used as if it were to `interactive' (*note Using Interactive::.). However, this feature is largely obsoleted by `defcustom' (*note Customization::.). *Warning:* If the `defconst' and `defvar' special forms are used while the variable has a local binding, they set the local binding's value; the global binding is not changed. This is not what we really want. To prevent it, use these special forms at top level in a file, where normally no local binding is in effect, and make sure to load the file before making a local binding for the variable. Tips for Defining Variables Robustly ==================================== When defining and initializing a variable that holds a complicated value (such as a keymap with bindings in it), it's best to put the entire computation of the value into the `defvar', like this: (defvar my-mode-map (let ((map (make-sparse-keymap))) (define-key map "\C-c\C-a" 'my-command) ... map) DOCSTRING) This method has several benefits. First, if the user quits while loading the file, the variable is either still uninitialized or initialized properly, never in-between. If it is still uninitialized, reloading the file will initialize it properly. Second, reloading the file once the variable is initialized will not alter it; that is important if the user has run hooks to alter part of the contents (such as, to rebind keys). Third, evaluating the `defvar' form with `C-M-x' *will* reinitialize the map completely. Putting so much code in the `defvar' form has one disadvantage: it puts the documentation string far away from the line which names the variable. Here's a safe way to avoid that: (defvar my-mode-map nil DOCSTRING) (if my-mode-map nil (let ((map (make-sparse-keymap))) (define-key my-mode-map "\C-c\C-a" 'my-command) ... (setq my-mode-map map))) This has all the same advantages as putting the initialization inside the `defvar', except that you must type `C-M-x' twice, once on each form, if you do want to reinitialize the variable. But be careful not to write the code like this: (defvar my-mode-map nil DOCSTRING) (if my-mode-map nil (setq my-mode-map (make-sparse-keymap)) (define-key my-mode-map "\C-c\C-a" 'my-command) ...) This code sets the variable, then alters it, but it does so in more than one step. If the user quits just after the `setq', that leaves the variable neither correctly initialized nor void nor `nil'. Once that happens, reloading the file will not initialize the variable; it will remain incomplete. Accessing Variable Values ========================= The usual way to reference a variable is to write the symbol which names it (*note Symbol Forms::.). This requires you to specify the variable name when you write the program. Usually that is exactly what you want to do. Occasionally you need to choose at run time which variable to reference; then you can use `symbol-value'. - Function: symbol-value SYMBOL This function returns the value of SYMBOL. This is the value in the innermost local binding of the symbol, or its global value if it has no local bindings. (setq abracadabra 5) => 5 (setq foo 9) => 9 ;; Here the symbol `abracadabra' ;; is the symbol whose value is examined. (let ((abracadabra 'foo)) (symbol-value 'abracadabra)) => foo ;; Here the value of `abracadabra', ;; which is `foo', ;; is the symbol whose value is examined. (let ((abracadabra 'foo)) (symbol-value abracadabra)) => 9 (symbol-value 'abracadabra) => 5 A `void-variable' error is signaled if the current binding of SYMBOL is void. How to Alter a Variable Value ============================= The usual way to change the value of a variable is with the special form `setq'. When you need to compute the choice of variable at run time, use the function `set'. - Special Form: setq [SYMBOL FORM]... This special form is the most common method of changing a variable's value. Each SYMBOL is given a new value, which is the result of evaluating the corresponding FORM. The most-local existing binding of the symbol is changed. `setq' does not evaluate SYMBOL; it sets the symbol that you write. We say that this argument is "automatically quoted". The `q' in `setq' stands for "quoted." The value of the `setq' form is the value of the last FORM. (setq x (1+ 2)) => 3 x ; `x' now has a global value. => 3 (let ((x 5)) (setq x 6) ; The local binding of `x' is set. x) => 6 x ; The global value is unchanged. => 3 Note that the first FORM is evaluated, then the first SYMBOL is set, then the second FORM is evaluated, then the second SYMBOL is set, and so on: (setq x 10 ; Notice that `x' is set before y (1+ x)) ; the value of `y' is computed. => 11 - Function: set SYMBOL VALUE This function sets SYMBOL's value to VALUE, then returns VALUE. Since `set' is a function, the expression written for SYMBOL is evaluated to obtain the symbol to set. The most-local existing binding of the variable is the binding that is set; shadowed bindings are not affected. (set one 1) error--> Symbol's value as variable is void: one (set 'one 1) => 1 (set 'two 'one) => one (set two 2) ; `two' evaluates to symbol `one'. => 2 one ; So it is `one' that was set. => 2 (let ((one 1)) ; This binding of `one' is set, (set 'one 3) ; not the global value. one) => 3 one => 2 If SYMBOL is not actually a symbol, a `wrong-type-argument' error is signaled. (set '(x y) 'z) error--> Wrong type argument: symbolp, (x y) Logically speaking, `set' is a more fundamental primitive than `setq'. Any use of `setq' can be trivially rewritten to use `set'; `setq' could even be defined as a macro, given the availability of `set'. However, `set' itself is rarely used; beginners hardly need to know about it. It is useful only for choosing at run time which variable to set. For example, the command `set-variable', which reads a variable name from the user and then sets the variable, needs to use `set'. Common Lisp note: In Common Lisp, `set' always changes the symbol's "special" or dynamic value, ignoring any lexical bindings. In Emacs Lisp, all variables and all bindings are dynamic, so `set' always affects the most local existing binding. One other function for setting a variable is designed to add an element to a list if it is not already present in the list. - Function: add-to-list SYMBOL ELEMENT This function sets the variable SYMBOL by consing ELEMENT onto the old value, if ELEMENT is not already a member of that value. It returns the resulting list, whether updated or not. The value of SYMBOL had better be a list already before the call. The argument SYMBOL is not implicitly quoted; `add-to-list' is an ordinary function, like `set' and unlike `setq'. Quote the argument yourself if that is what you want. Here's a scenario showing how to use `add-to-list': (setq foo '(a b)) => (a b) (add-to-list 'foo 'c) ;; Add `c'. => (c a b) (add-to-list 'foo 'b) ;; No effect. => (c a b) foo ;; `foo' was changed. => (c a b) An equivalent expression for `(add-to-list 'VAR VALUE)' is this: (or (member VALUE VAR) (setq VAR (cons VALUE VAR))) Scoping Rules for Variable Bindings =================================== A given symbol `foo' can have several local variable bindings, established at different places in the Lisp program, as well as a global binding. The most recently established binding takes precedence over the others. Local bindings in Emacs Lisp have "indefinite scope" and "dynamic extent". "Scope" refers to *where* textually in the source code the binding can be accessed. Indefinite scope means that any part of the program can potentially access the variable binding. "Extent" refers to *when*, as the program is executing, the binding exists. Dynamic extent means that the binding lasts as long as the activation of the construct that established it. The combination of dynamic extent and indefinite scope is called "dynamic scoping". By contrast, most programming languages use "lexical scoping", in which references to a local variable must be located textually within the function or block that binds the variable. Common Lisp note: Variables declared "special" in Common Lisp are dynamically scoped, like all variables in Emacs Lisp. Scope ----- Emacs Lisp uses "indefinite scope" for local variable bindings. This means that any function anywhere in the program text might access a given binding of a variable. Consider the following function definitions: (defun binder (x) ; `x' is bound in `binder'. (foo 5)) ; `foo' is some other function. (defun user () ; `x' is used "free" in `user'. (list x)) In a lexically scoped language, the binding of `x' in `binder' would never be accessible in `user', because `user' is not textually contained within the function `binder'. However, in dynamically scoped Emacs Lisp, `user' may or may not refer to the binding of `x' established in `binder', depending on circumstances: * If we call `user' directly without calling `binder' at all, then whatever binding of `x' is found, it cannot come from `binder'. * If we define `foo' as follows and then call `binder', then the binding made in `binder' will be seen in `user': (defun foo (lose) (user)) * However, if we define `foo' as follows and then call `binder', then the binding made in `binder' *will not* be seen in `user': (defun foo (x) (user)) Here, when `foo' is called by `binder', it binds `x'. (The binding in `foo' is said to "shadow" the one made in `binder'.) Therefore, `user' will access the `x' bound by `foo' instead of the one bound by `binder'. Emacs Lisp uses dynamic scoping because simple implementations of lexical scoping are slow. In addition, every Lisp system needs to offer dynamic scoping at least as an option; if lexical scoping is the norm, there must be a way to specify dynamic scoping instead for a particular variable. It might not be a bad thing for Emacs to offer both, but implementing it with dynamic scoping only was much easier. Extent ------ "Extent" refers to the time during program execution that a variable name is valid. In Emacs Lisp, a variable is valid only while the form that bound it is executing. This is called "dynamic extent". "Local" or "automatic" variables in most languages, including C and Pascal, have dynamic extent. One alternative to dynamic extent is "indefinite extent". This means that a variable binding can live on past the exit from the form that made the binding. Common Lisp and Scheme, for example, support this, but Emacs Lisp does not. To illustrate this, the function below, `make-add', returns a function that purports to add N to its own argument M. This would work in Common Lisp, but it does not do the job in Emacs Lisp, because after the call to `make-add' exits, the variable `n' is no longer bound to the actual argument 2. (defun make-add (n) (function (lambda (m) (+ n m)))) ; Return a function. => make-add (fset 'add2 (make-add 2)) ; Define function `add2' ; with `(make-add 2)'. => (lambda (m) (+ n m)) (add2 4) ; Try to add 2 to 4. error--> Symbol's value as variable is void: n Some Lisp dialects have "closures", objects that are like functions but record additional variable bindings. Emacs Lisp does not have closures. Implementation of Dynamic Scoping --------------------------------- A simple sample implementation (which is not how Emacs Lisp actually works) may help you understand dynamic binding. This technique is called "deep binding" and was used in early Lisp systems. Suppose there is a stack of bindings, which are variable-value pairs. At entry to a function or to a `let' form, we can push bindings onto the stack for the arguments or local variables created there. We can pop those bindings from the stack at exit from the binding construct. We can find the value of a variable by searching the stack from top to bottom for a binding for that variable; the value from that binding is the value of the variable. To set the variable, we search for the current binding, then store the new value into that binding. As you can see, a function's bindings remain in effect as long as it continues execution, even during its calls to other functions. That is why we say the extent of the binding is dynamic. And any other function can refer to the bindings, if it uses the same variables while the bindings are in effect. That is why we say the scope is indefinite. The actual implementation of variable scoping in GNU Emacs Lisp uses a technique called "shallow binding". Each variable has a standard place in which its current value is always found--the value cell of the symbol. In shallow binding, setting the variable works by storing a value in the value cell. Creating a new binding works by pushing the old value (belonging to a previous binding) onto a stack, and storing the new local value in the value cell. Eliminating a binding works by popping the old value off the stack, into the value cell. We use shallow binding because it has the same results as deep binding, but runs faster, since there is never a need to search for a binding. Proper Use of Dynamic Scoping ----------------------------- Binding a variable in one function and using it in another is a powerful technique, but if used without restraint, it can make programs hard to understand. There are two clean ways to use this technique: * Use or bind the variable only in a few related functions, written close together in one file. Such a variable is used for communication within one program. You should write comments to inform other programmers that they can see all uses of the variable before them, and to advise them not to add uses elsewhere. * Give the variable a well-defined, documented meaning, and make all appropriate functions refer to it (but not bind it or set it) wherever that meaning is relevant. For example, the variable `case-fold-search' is defined as "non-`nil' means ignore case when searching"; various search and replace functions refer to it directly or through their subroutines, but do not bind or set it. Then you can bind the variable in other programs, knowing reliably what the effect will be. In either case, you should define the variable with `defvar'. This helps other people understand your program by telling them to look for inter-function usage. It also avoids a warning from the byte compiler. Choose the variable's name to avoid name conflicts--don't use short names like `x'. Buffer-Local Variables ====================== Global and local variable bindings are found in most programming languages in one form or another. Emacs also supports additional, unusual kinds of variable binding: "buffer-local" bindings, which apply only in one buffer, and frame-local bindings, which apply only in one frame. Having different values for a variable in different buffers and/or frames is an important customization method. This section describes buffer-local bindings; for frame-local bindings, see the following section, *Note Frame-Local Variables::. (A few variables have bindings that are local to each terminal; see *Note Multiple Displays::.) Introduction to Buffer-Local Variables -------------------------------------- A buffer-local variable has a buffer-local binding associated with a particular buffer. The binding is in effect when that buffer is current; otherwise, it is not in effect. If you set the variable while a buffer-local binding is in effect, the new value goes in that binding, so its other bindings are unchanged. This means that the change is visible only in the buffer where you made it. The variable's ordinary binding, which is not associated with any specific buffer, is called the "default binding". In most cases, this is the global binding. A variable can have buffer-local bindings in some buffers but not in other buffers. The default binding is shared by all the buffers that don't have their own bindings for the variable. (This includes all newly created buffers.) If you set the variable in a buffer that does not have a buffer-local binding for it, this sets the default binding (assuming there are no frame-local bindings to complicate the matter), so the new value is visible in all the buffers that see the default binding. The most common use of buffer-local bindings is for major modes to change variables that control the behavior of commands. For example, C mode and Lisp mode both set the variable `paragraph-start' to specify that only blank lines separate paragraphs. They do this by making the variable buffer-local in the buffer that is being put into C mode or Lisp mode, and then setting it to the new value for that mode. *Note Major Modes::. The usual way to make a buffer-local binding is with `make-local-variable', which is what major mode commands typically use. This affects just the current buffer; all other buffers (including those yet to be created) will continue to share the default value unless they are explicitly given their own buffer-local bindings. A more powerful operation is to mark the variable as "automatically buffer-local" by calling `make-variable-buffer-local'. You can think of this as making the variable local in all buffers, even those yet to be created. More precisely, the effect is that setting the variable automatically makes the variable local to the current buffer if it is not already so. All buffers start out by sharing the default value of the variable as usual, but setting the variable creates a buffer-local binding for the current buffer. The new value is stored in the buffer-local binding, leaving the default binding untouched. This means that the default value cannot be changed with `setq' in any buffer; the only way to change it is with `setq-default'. *Warning:* When a variable has buffer-local values in one or more buffers, you can get Emacs very confused by binding the variable with `let', changing to a different current buffer in which a different binding is in effect, and then exiting the `let'. This can scramble the values of the buffer-local and default bindings. To preserve your sanity, avoid using a variable in that way. If you use `save-excursion' around each piece of code that changes to a different current buffer, you will not have this problem (*note Excursions::.). Here is an example of what to avoid: (setq foo 'b) (set-buffer "a") (make-local-variable 'foo) (setq foo 'a) (let ((foo 'temp)) (set-buffer "b") BODY...) foo => 'a ; The old buffer-local value from buffer `a' ; is now the default value. (set-buffer "a") foo => 'temp ; The local `let' value that should be gone ; is now the buffer-local value in buffer `a'. But `save-excursion' as shown here avoids the problem: (let ((foo 'temp)) (save-excursion (set-buffer "b") BODY...)) Note that references to `foo' in BODY access the buffer-local binding of buffer `b'. When a file specifies local variable values, these become buffer-local values when you visit the file. *Note File Variables: (emacs)File Variables. Creating and Deleting Buffer-Local Bindings ------------------------------------------- - Command: make-local-variable VARIABLE This function creates a buffer-local binding in the current buffer for VARIABLE (a symbol). Other buffers are not affected. The value returned is VARIABLE. The buffer-local value of VARIABLE starts out as the same value VARIABLE previously had. If VARIABLE was void, it remains void. ;; In buffer `b1': (setq foo 5) ; Affects all buffers. => 5 (make-local-variable 'foo) ; Now it is local in `b1'. => foo foo ; That did not change => 5 ; the value. (setq foo 6) ; Change the value => 6 ; in `b1'. foo => 6 ;; In buffer `b2', the value hasn't changed. (save-excursion (set-buffer "b2") foo) => 5 Making a variable buffer-local within a `let'-binding for that variable does not work reliably, unless the buffer in which you do this is not current either on entry to or exit from the `let'. This is because `let' does not distinguish between different kinds of bindings; it knows only which variable the binding was made for. If the variable is terminal-local, this function signals an error. Such variables cannot have buffer-local bindings as well. *Note Multiple Displays::. *Note:* do not use `make-local-variable' for a hook variable. Instead, use `make-local-hook'. *Note Hooks::. - Command: make-variable-buffer-local VARIABLE This function marks VARIABLE (a symbol) automatically buffer-local, so that any subsequent attempt to set it will make it local to the current buffer at the time. A peculiar wrinkle of this feature is that binding the variable (with `let' or other binding constructs) does not create a buffer-local binding for it. Only setting the variable (with `set' or `setq') does so. The value returned is VARIABLE. *Warning:* Don't assume that you should use `make-variable-buffer-local' for user-option variables, simply because users *might* want to customize them differently in different buffers. Users can make any variable local, when they wish to. It is better to leave the choice to them. The time to use `make-variable-buffer-local' is when it is crucial that no two buffers ever share the same binding. For example, when a variable is used for internal purposes in a Lisp program which depends on having separate values in separate buffers, then using `make-variable-buffer-local' can be the best solution. - Function: local-variable-p VARIABLE &optional BUFFER This returns `t' if VARIABLE is buffer-local in buffer BUFFER (which defaults to the current buffer); otherwise, `nil'. - Function: buffer-local-variables &optional BUFFER This function returns a list describing the buffer-local variables in buffer BUFFER. (If BUFFER is omitted, the current buffer is used.) It returns an association list (*note Association Lists::.) in which each element contains one buffer-local variable and its value. However, when a variable's buffer-local binding in BUFFER is void, then the variable appears directly in the resulting list. (make-local-variable 'foobar) (makunbound 'foobar) (make-local-variable 'bind-me) (setq bind-me 69) (setq lcl (buffer-local-variables)) ;; First, built-in variables local in all buffers: => ((mark-active . nil) (buffer-undo-list . nil) (mode-name . "Fundamental") ... ;; Next, non-built-in buffer-local variables. ;; This one is buffer-local and void: foobar ;; This one is buffer-local and nonvoid: (bind-me . 69)) Note that storing new values into the CDRs of cons cells in this list does *not* change the buffer-local values of the variables. - Command: kill-local-variable VARIABLE This function deletes the buffer-local binding (if any) for VARIABLE (a symbol) in the current buffer. As a result, the default binding of VARIABLE becomes visible in this buffer. This typically results in a change in the value of VARIABLE, since the default value is usually different from the buffer-local value just eliminated. If you kill the buffer-local binding of a variable that automatically becomes buffer-local when set, this makes the default value visible in the current buffer. However, if you set the variable again, that will once again create a buffer-local binding for it. `kill-local-variable' returns VARIABLE. This function is a command because it is sometimes useful to kill one buffer-local variable interactively, just as it is useful to create buffer-local variables interactively. - Function: kill-all-local-variables This function eliminates all the buffer-local variable bindings of the current buffer except for variables marked as "permanent". As a result, the buffer will see the default values of most variables. This function also resets certain other information pertaining to the buffer: it sets the local keymap to `nil', the syntax table to the value of `(standard-syntax-table)', the case table to `(standard-case-table)', and the abbrev table to the value of `fundamental-mode-abbrev-table'. The very first thing this function does is run the normal hook `change-major-mode-hook' (see below). Every major mode command begins by calling this function, which has the effect of switching to Fundamental mode and erasing most of the effects of the previous major mode. To ensure that this does its job, the variables that major modes set should not be marked permanent. `kill-all-local-variables' returns `nil'. - Variable: change-major-mode-hook The function `kill-all-local-variables' runs this normal hook before it does anything else. This gives major modes a way to arrange for something special to be done if the user switches to a different major mode. For best results, make this variable buffer-local, so that it will disappear after doing its job and will not interfere with the subsequent major mode. *Note Hooks::. A buffer-local variable is "permanent" if the variable name (a symbol) has a `permanent-local' property that is non-`nil'. Permanent locals are appropriate for data pertaining to where the file came from or how to save it, rather than with how to edit the contents. The Default Value of a Buffer-Local Variable -------------------------------------------- The global value of a variable with buffer-local bindings is also called the "default" value, because it is the value that is in effect whenever neither the current buffer nor the selected frame has its own binding for the variable. The functions `default-value' and `setq-default' access and change a variable's default value regardless of whether the current buffer has a buffer-local binding. For example, you could use `setq-default' to change the default setting of `paragraph-start' for most buffers; and this would work even when you are in a C or Lisp mode buffer that has a buffer-local value for this variable. The special forms `defvar' and `defconst' also set the default value (if they set the variable at all), rather than any buffer-local or frame-local value. - Function: default-value SYMBOL This function returns SYMBOL's default value. This is the value that is seen in buffers and frames that do not have their own values for this variable. If SYMBOL is not buffer-local, this is equivalent to `symbol-value' (*note Accessing Variables::.). - Function: default-boundp SYMBOL The function `default-boundp' tells you whether SYMBOL's default value is nonvoid. If `(default-boundp 'foo)' returns `nil', then `(default-value 'foo)' would get an error. `default-boundp' is to `default-value' as `boundp' is to `symbol-value'. - Special Form: setq-default [SYMBOL FORM]... This special form gives each SYMBOL a new default value, which is the result of evaluating the corresponding FORM. It does not evaluate SYMBOL, but does evaluate FORM. The value of the `setq-default' form is the value of the last FORM. If a SYMBOL is not buffer-local for the current buffer, and is not marked automatically buffer-local, `setq-default' has the same effect as `setq'. If SYMBOL is buffer-local for the current buffer, then this changes the value that other buffers will see (as long as they don't have a buffer-local value), but not the value that the current buffer sees. ;; In buffer `foo': (make-local-variable 'buffer-local) => buffer-local (setq buffer-local 'value-in-foo) => value-in-foo (setq-default buffer-local 'new-default) => new-default buffer-local => value-in-foo (default-value 'buffer-local) => new-default ;; In (the new) buffer `bar': buffer-local => new-default (default-value 'buffer-local) => new-default (setq buffer-local 'another-default) => another-default (default-value 'buffer-local) => another-default ;; Back in buffer `foo': buffer-local => value-in-foo (default-value 'buffer-local) => another-default - Function: set-default SYMBOL VALUE This function is like `setq-default', except that SYMBOL is an ordinary evaluated argument. (set-default (car '(a b c)) 23) => 23 (default-value 'a) => 23 Frame-Local Variables ===================== Just as variables can have buffer-local bindings, they can also have frame-local bindings. These bindings belong to one frame, and are in effect when that frame is selected. Frame-local bindings are actually frame parameters: you create a frame-local binding in a specific frame by calling `modify-frame-parameters' and specifying the variable name as the parameter name. To enable frame-local bindings for a certain variable, call the function `make-variable-frame-local'. - Command: make-variable-frame-local VARIABLE Enable the use of frame-local bindings for VARIABLE. This does not in itself create any frame-local bindings for the variable; however, if some frame already has a value for VARIABLE as a frame parameter, that value automatically becomes a frame-local binding. If the variable is terminal-local, this function signals an error, because such variables cannot have frame-local bindings as well. *Note Multiple Displays::. A few variables that are implemented specially in Emacs can be (and usually are) buffer-local, but can never be frame-local. Buffer-local bindings take precedence over frame-local bindings. Thus, consider a variable `foo': if the current buffer has a buffer-local binding for `foo', that binding is active; otherwise, if the selected frame has a frame-local binding for `foo', that binding is active; otherwise, the default binding of `foo' is active. Here is an example. First we prepare a few bindings for `foo': (setq f1 (selected-frame)) (make-variable-frame-local 'foo) ;; Make a buffer-local binding for `foo' in `b1'. (set-buffer (get-buffer-create "b1")) (make-local-variable 'foo) (setq foo '(b 1)) ;; Make a frame-local binding for `foo' in a new frame. ;; Store that frame in `f2'. (setq f2 (make-frame)) (modify-frame-parameters f2 '((foo . (f 2)))) Now we examine `foo' in various contexts. Whenever the buffer `b1' is current, its buffer-local binding is in effect, regardless of the selected frame: (select-frame f1) (set-buffer (get-buffer-create "b1")) foo => (b 1) (select-frame f2) (set-buffer (get-buffer-create "b1")) foo => (b 1) Otherwise, the frame gets a chance to provide the binding; when frame `f2' is selected, its frame-local binding is in effect: (select-frame f2) (set-buffer (get-buffer "*scratch*")) foo => (f 2) When neither the current buffer nor the selected frame provides a binding, the default binding is used: (select-frame f1) (set-buffer (get-buffer "*scratch*")) foo => nil When the active binding of a variable is a frame-local binding, setting the variable changes that binding. You can observe the result with `frame-parameters': (select-frame f2) (set-buffer (get-buffer "*scratch*")) (setq foo 'nobody) (assq 'foo (frame-parameters f2)) => (foo . nobody) Possible Future Local Variables =============================== We have considered the idea of bindings that are local to a category of frames--for example, all color frames, or all frames with dark backgrounds. We have not implemented them because it is not clear that this feature is really useful. You can get more or less the same results by adding a function to `after-make-frame-hook', set up to define a particular frame parameter according to the appropriate conditions for each frame. It would also be possible to implement window-local bindings. We don't know of many situations where they would be useful, and it seems that indirect buffers (*note Indirect Buffers::.) with buffer-local bindings offer a way to handle these situations more robustly. If sufficient application is found for either of these two kinds of local bindings, we will provide it in a subsequent Emacs version. Functions ********* A Lisp program is composed mainly of Lisp functions. This chapter explains what functions are, how they accept arguments, and how to define them. What Is a Function? =================== In a general sense, a function is a rule for carrying on a computation given several values called "arguments". The result of the computation is called the value of the function. The computation can also have side effects: lasting changes in the values of variables or the contents of data structures. Here are important terms for functions in Emacs Lisp and for other function-like objects. "function" In Emacs Lisp, a "function" is anything that can be applied to arguments in a Lisp program. In some cases, we use it more specifically to mean a function written in Lisp. Special forms and macros are not functions. "primitive" A "primitive" is a function callable from Lisp that is written in C, such as `car' or `append'. These functions are also called "built-in" functions or "subrs". (Special forms are also considered primitives.) Usually the reason we implement a function as a primitive is either because it is fundamental, because it provides a low-level interface to operating system services, or because it needs to run fast. Primitives can be modified or added only by changing the C sources and recompiling the editor. See *Note Writing Emacs Primitives::. "lambda expression" A "lambda expression" is a function written in Lisp. These are described in the following section. *Note Lambda Expressions::. "special form" A "special form" is a primitive that is like a function but does not evaluate all of its arguments in the usual way. It may evaluate only some of the arguments, or may evaluate them in an unusual order, or several times. Many special forms are described in *Note Control Structures::. "macro" A "macro" is a construct defined in Lisp by the programmer. It differs from a function in that it translates a Lisp expression that you write into an equivalent expression to be evaluated instead of the original expression. Macros enable Lisp programmers to do the sorts of things that special forms can do. *Note Macros::, for how to define and use macros. "command" A "command" is an object that `command-execute' can invoke; it is a possible definition for a key sequence. Some functions are commands; a function written in Lisp is a command if it contains an interactive declaration (*note Defining Commands::.). Such a function can be called from Lisp expressions like other functions; in this case, the fact that the function is a command makes no difference. Keyboard macros (strings and vectors) are commands also, even though they are not functions. A symbol is a command if its function definition is a command; such symbols can be invoked with `M-x'. The symbol is a function as well if the definition is a function. *Note Command Overview::. "keystroke command" A "keystroke command" is a command that is bound to a key sequence (typically one to three keystrokes). The distinction is made here merely to avoid confusion with the meaning of "command" in non-Emacs editors; for Lisp programs, the distinction is normally unimportant. "byte-code function" A "byte-code function" is a function that has been compiled by the byte compiler. *Note Byte-Code Type::. - Function: functionp OBJECT This function returns `t' if OBJECT is any kind of function, or a special form or macro. - Function: subrp OBJECT This function returns `t' if OBJECT is a built-in function (i.e., a Lisp primitive). (subrp 'message) ; `message' is a symbol, => nil ; not a subr object. (subrp (symbol-function 'message)) => t - Function: byte-code-function-p OBJECT This function returns `t' if OBJECT is a byte-code function. For example: (byte-code-function-p (symbol-function 'next-line)) => t Lambda Expressions ================== A function written in Lisp is a list that looks like this: (lambda (ARG-VARIABLES...) [DOCUMENTATION-STRING] [INTERACTIVE-DECLARATION] BODY-FORMS...) Such a list is called a "lambda expression". In Emacs Lisp, it actually is valid as an expression--it evaluates to itself. In some other Lisp dialects, a lambda expression is not a valid expression at all. In either case, its main use is not to be evaluated as an expression, but to be called as a function. Components of a Lambda Expression --------------------------------- A function written in Lisp (a "lambda expression") is a list that looks like this: (lambda (ARG-VARIABLES...) [DOCUMENTATION-STRING] [INTERACTIVE-DECLARATION] BODY-FORMS...) The first element of a lambda expression is always the symbol `lambda'. This indicates that the list represents a function. The reason functions are defined to start with `lambda' is so that other lists, intended for other uses, will not accidentally be valid as functions. The second element is a list of symbols--the argument variable names. This is called the "lambda list". When a Lisp function is called, the argument values are matched up against the variables in the lambda list, which are given local bindings with the values provided. *Note Local Variables::. The documentation string is a Lisp string object placed within the function definition to describe the function for the Emacs help facilities. *Note Function Documentation::. The interactive declaration is a list of the form `(interactive CODE-STRING)'. This declares how to provide arguments if the function is used interactively. Functions with this declaration are called "commands"; they can be called using `M-x' or bound to a key. Functions not intended to be called in this way should not have interactive declarations. *Note Defining Commands::, for how to write an interactive declaration. The rest of the elements are the "body" of the function: the Lisp code to do the work of the function (or, as a Lisp programmer would say, "a list of Lisp forms to evaluate"). The value returned by the function is the value returned by the last element of the body. A Simple Lambda-Expression Example ---------------------------------- Consider for example the following function: (lambda (a b c) (+ a b c)) We can call this function by writing it as the CAR of an expression, like this: ((lambda (a b c) (+ a b c)) 1 2 3) This call evaluates the body of the lambda expression with the variable `a' bound to 1, `b' bound to 2, and `c' bound to 3. Evaluation of the body adds these three numbers, producing the result 6; therefore, this call to the function returns the value 6. Note that the arguments can be the results of other function calls, as in this example: ((lambda (a b c) (+ a b c)) 1 (* 2 3) (- 5 4)) This evaluates the arguments `1', `(* 2 3)', and `(- 5 4)' from left to right. Then it applies the lambda expression to the argument values 1, 6 and 1 to produce the value 8. It is not often useful to write a lambda expression as the CAR of a form in this way. You can get the same result, of making local variables and giving them values, using the special form `let' (*note Local Variables::.). And `let' is clearer and easier to use. In practice, lambda expressions are either stored as the function definitions of symbols, to produce named functions, or passed as arguments to other functions (*note Anonymous Functions::.). However, calls to explicit lambda expressions were very useful in the old days of Lisp, before the special form `let' was invented. At that time, they were the only way to bind and initialize local variables. Other Features of Argument Lists -------------------------------- Our simple sample function, `(lambda (a b c) (+ a b c))', specifies three argument variables, so it must be called with three arguments: if you try to call it with only two arguments or four arguments, you get a `wrong-number-of-arguments' error. It is often convenient to write a function that allows certain arguments to be omitted. For example, the function `substring' accepts three arguments--a string, the start index and the end index--but the third argument defaults to the LENGTH of the string if you omit it. It is also convenient for certain functions to accept an indefinite number of arguments, as the functions `list' and `+' do. To specify optional arguments that may be omitted when a function is called, simply include the keyword `&optional' before the optional arguments. To specify a list of zero or more extra arguments, include the keyword `&rest' before one final argument. Thus, the complete syntax for an argument list is as follows: (REQUIRED-VARS... [&optional OPTIONAL-VARS...] [&rest REST-VAR]) The square brackets indicate that the `&optional' and `&rest' clauses, and the variables that follow them, are optional. A call to the function requires one actual argument for each of the REQUIRED-VARS. There may be actual arguments for zero or more of the OPTIONAL-VARS, and there cannot be any actual arguments beyond that unless the lambda list uses `&rest'. In that case, there may be any number of extra actual arguments. If actual arguments for the optional and rest variables are omitted, then they always default to `nil'. There is no way for the function to distinguish between an explicit argument of `nil' and an omitted argument. However, the body of the function is free to consider `nil' an abbreviation for some other meaningful value. This is what `substring' does; `nil' as the third argument to `substring' means to use the length of the string supplied. Common Lisp note: Common Lisp allows the function to specify what default value to use when an optional argument is omitted; Emacs Lisp always uses `nil'. Emacs Lisp does not support "supplied-p" variables that tell you whether an argument was explicitly passed. For example, an argument list that looks like this: (a b &optional c d &rest e) binds `a' and `b' to the first two actual arguments, which are required. If one or two more arguments are provided, `c' and `d' are bound to them respectively; any arguments after the first four are collected into a list and `e' is bound to that list. If there are only two arguments, `c' is `nil'; if two or three arguments, `d' is `nil'; if four arguments or fewer, `e' is `nil'. There is no way to have required arguments following optional ones--it would not make sense. To see why this must be so, suppose that `c' in the example were optional and `d' were required. Suppose three actual arguments are given; which variable would the third argument be for? Similarly, it makes no sense to have any more arguments (either required or optional) after a `&rest' argument. Here are some examples of argument lists and proper calls: ((lambda (n) (1+ n)) ; One required: 1) ; requires exactly one argument. => 2 ((lambda (n &optional n1) ; One required and one optional: (if n1 (+ n n1) (1+ n))) ; 1 or 2 arguments. 1 2) => 3 ((lambda (n &rest ns) ; One required and one rest: (+ n (apply '+ ns))) ; 1 or more arguments. 1 2 3 4 5) => 15 Documentation Strings of Functions ---------------------------------- A lambda expression may optionally have a "documentation string" just after the lambda list. This string does not affect execution of the function; it is a kind of comment, but a systematized comment which actually appears inside the Lisp world and can be used by the Emacs help facilities. *Note Documentation::, for how the DOCUMENTATION-STRING is accessed. It is a good idea to provide documentation strings for all the functions in your program, even those that are called only from within your program. Documentation strings are like comments, except that they are easier to access. The first line of the documentation string should stand on its own, because `apropos' displays just this first line. It should consist of one or two complete sentences that summarize the function's purpose. The start of the documentation string is usually indented in the source file, but since these spaces come before the starting double-quote, they are not part of the string. Some people make a practice of indenting any additional lines of the string so that the text lines up in the program source. *This is a mistake.* The indentation of the following lines is inside the string; what looks nice in the source code will look ugly when displayed by the help commands. You may wonder how the documentation string could be optional, since there are required components of the function that follow it (the body). Since evaluation of a string returns that string, without any side effects, it has no effect if it is not the last form in the body. Thus, in practice, there is no confusion between the first form of the body and the documentation string; if the only body form is a string then it serves both as the return value and as the documentation. Naming a Function ================= In most computer languages, every function has a name; the idea of a function without a name is nonsensical. In Lisp, a function in the strictest sense has no name. It is simply a list whose first element is `lambda', a byte-code function object, or a primitive subr-object. However, a symbol can serve as the name of a function. This happens when you put the function in the symbol's "function cell" (*note Symbol Components::.). Then the symbol itself becomes a valid, callable function, equivalent to the list or subr-object that its function cell refers to. The contents of the function cell are also called the symbol's "function definition". The procedure of using a symbol's function definition in place of the symbol is called "symbol function indirection"; see *Note Function Indirection::. In practice, nearly all functions are given names in this way and referred to through their names. For example, the symbol `car' works as a function and does what it does because the primitive subr-object `#' is stored in its function cell. We give functions names because it is convenient to refer to them by their names in Lisp expressions. For primitive subr-objects such as `#', names are the only way you can refer to them: there is no read syntax for such objects. For functions written in Lisp, the name is more convenient to use in a call than an explicit lambda expression. Also, a function with a name can refer to itself--it can be recursive. Writing the function's name in its own definition is much more convenient than making the function definition point to itself (something that is not impossible but that has various disadvantages in practice). We often identify functions with the symbols used to name them. For example, we often speak of "the function `car'", not distinguishing between the symbol `car' and the primitive subr-object that is its function definition. For most purposes, there is no need to distinguish. Even so, keep in mind that a function need not have a unique name. While a given function object *usually* appears in the function cell of only one symbol, this is just a matter of convenience. It is easy to store it in several symbols using `fset'; then each of the symbols is equally well a name for the same function. A symbol used as a function name may also be used as a variable; these two uses of a symbol are independent and do not conflict. (Some Lisp dialects, such as Scheme, do not distinguish between a symbol's value and its function definition; a symbol's value as a variable is also its function definition.) If you have not given a symbol a function definition, you cannot use it as a function; whether the symbol has a value as a variable makes no difference to this. Defining Functions ================== We usually give a name to a function when it is first created. This is called "defining a function", and it is done with the `defun' special form. - Special Form: defun NAME ARGUMENT-LIST BODY-FORMS `defun' is the usual way to define new Lisp functions. It defines the symbol NAME as a function that looks like this: (lambda ARGUMENT-LIST . BODY-FORMS) `defun' stores this lambda expression in the function cell of NAME. It returns the value NAME, but usually we ignore this value. As described previously (*note Lambda Expressions::.), ARGUMENT-LIST is a list of argument names and may include the keywords `&optional' and `&rest'. Also, the first two of the BODY-FORMS may be a documentation string and an interactive declaration. There is no conflict if the same symbol NAME is also used as a variable, since the symbol's value cell is independent of the function cell. *Note Symbol Components::. Here are some examples: (defun foo () 5) => foo (foo) => 5 (defun bar (a &optional b &rest c) (list a b c)) => bar (bar 1 2 3 4 5) => (1 2 (3 4 5)) (bar 1) => (1 nil nil) (bar) error--> Wrong number of arguments. (defun capitalize-backwards () "Upcase the last letter of a word." (interactive) (backward-word 1) (forward-word 1) (backward-char 1) (capitalize-word 1)) => capitalize-backwards Be careful not to redefine existing functions unintentionally. `defun' redefines even primitive functions such as `car' without any hesitation or notification. Redefining a function already defined is often done deliberately, and there is no way to distinguish deliberate redefinition from unintentional redefinition. - Function: defalias NAME DEFINITION This special form defines the symbol NAME as a function, with definition DEFINITION (which can be any valid Lisp function). The proper place to use `defalias' is where a specific function name is being defined--especially where that name appears explicitly in the source file being loaded. This is because `defalias' records which file defined the function, just like `defun' (*note Unloading::.). By contrast, in programs that manipulate function definitions for other purposes, it is better to use `fset', which does not keep such records. See also `defsubst', which defines a function like `defun' and tells the Lisp compiler to open-code it. *Note Inline Functions::. Calling Functions ================= Defining functions is only half the battle. Functions don't do anything until you "call" them, i.e., tell them to run. Calling a function is also known as "invocation". The most common way of invoking a function is by evaluating a list. For example, evaluating the list `(concat "a" "b")' calls the function `concat' with arguments `"a"' and `"b"'. *Note Evaluation::, for a description of evaluation. When you write a list as an expression in your program, the function name it calls is written in your program. This means that you choose which function to call, and how many arguments to give it, when you write the program. Usually that's just what you want. Occasionally you need to compute at run time which function to call. To do that, use the function `funcall'. When you also need to determine at run time how many arguments to pass, use `apply'. - Function: funcall FUNCTION &rest ARGUMENTS `funcall' calls FUNCTION with ARGUMENTS, and returns whatever FUNCTION returns. Since `funcall' is a function, all of its arguments, including FUNCTION, are evaluated before `funcall' is called. This means that you can use any expression to obtain the function to be called. It also means that `funcall' does not see the expressions you write for the ARGUMENTS, only their values. These values are *not* evaluated a second time in the act of calling FUNCTION; `funcall' enters the normal procedure for calling a function at the place where the arguments have already been evaluated. The argument FUNCTION must be either a Lisp function or a primitive function. Special forms and macros are not allowed, because they make sense only when given the "unevaluated" argument expressions. `funcall' cannot provide these because, as we saw above, it never knows them in the first place. (setq f 'list) => list (funcall f 'x 'y 'z) => (x y z) (funcall f 'x 'y '(z)) => (x y (z)) (funcall 'and t nil) error--> Invalid function: # Compare these example with the examples of `apply'. - Function: apply FUNCTION &rest ARGUMENTS `apply' calls FUNCTION with ARGUMENTS, just like `funcall' but with one difference: the last of ARGUMENTS is a list of objects, which are passed to FUNCTION as separate arguments, rather than a single list. We say that `apply' "spreads" this list so that each individual element becomes an argument. `apply' returns the result of calling FUNCTION. As with `funcall', FUNCTION must either be a Lisp function or a primitive function; special forms and macros do not make sense in `apply'. (setq f 'list) => list (apply f 'x 'y 'z) error--> Wrong type argument: listp, z (apply '+ 1 2 '(3 4)) => 10 (apply '+ '(1 2 3 4)) => 10 (apply 'append '((a b c) nil (x y z) nil)) => (a b c x y z) For an interesting example of using `apply', see the description of `mapcar', in *Note Mapping Functions::. It is common for Lisp functions to accept functions as arguments or find them in data structures (especially in hook variables and property lists) and call them using `funcall' or `apply'. Functions that accept function arguments are often called "functionals". Sometimes, when you call a functional, it is useful to supply a no-op function as the argument. Here are two different kinds of no-op function: - Function: identity ARG This function returns ARG and has no side effects. - Function: ignore &rest ARGS This function ignores any arguments and returns `nil'. Mapping Functions ================= A "mapping function" applies a given function to each element of a list or other collection. Emacs Lisp has several such functions; `mapcar' and `mapconcat', which scan a list, are described here. *Note Creating Symbols::, for the function `mapatoms' which maps over the symbols in an obarray. These mapping functions do not allow char-tables because a char-table is a sparse array whose nominal range of indices is very large. To map over a char-table in a way that deals properly with its sparse nature, use the function `map-char-table' (*note Char-Tables::.). - Function: mapcar FUNCTION SEQUENCE `mapcar' applies FUNCTION to each element of SEQUENCE in turn, and returns a list of the results. The argument SEQUENCE can be any kind of sequence except a char-table; that is, a list, a vector, a bool-vector, or a string. The result is always a list. The length of the result is the same as the length of SEQUENCE. For example: (mapcar 'car '((a b) (c d) (e f))) => (a c e) (mapcar '1+ [1 2 3]) => (2 3 4) (mapcar 'char-to-string "abc") => ("a" "b" "c") ;; Call each function in `my-hooks'. (mapcar 'funcall my-hooks) (defun mapcar* (function &rest args) "Apply FUNCTION to successive cars of all ARGS. Return the list of results." ;; If no list is exhausted, (if (not (memq 'nil args)) ;; apply function to CARs. (cons (apply function (mapcar 'car args)) (apply 'mapcar* function ;; Recurse for rest of elements. (mapcar 'cdr args))))) (mapcar* 'cons '(a b c) '(1 2 3 4)) => ((a . 1) (b . 2) (c . 3)) - Function: mapconcat FUNCTION SEQUENCE SEPARATOR `mapconcat' applies FUNCTION to each element of SEQUENCE: the results, which must be strings, are concatenated. Between each pair of result strings, `mapconcat' inserts the string SEPARATOR. Usually SEPARATOR contains a space or comma or other suitable punctuation. The argument FUNCTION must be a function that can take one argument and return a string. The argument SEQUENCE can be any kind of sequence except a char-table; that is, a list, a vector, a bool-vector, or a string. (mapconcat 'symbol-name '(The cat in the hat) " ") => "The cat in the hat" (mapconcat (function (lambda (x) (format "%c" (1+ x)))) "HAL-8000" "") => "IBM.9111" Anonymous Functions =================== In Lisp, a function is a list that starts with `lambda', a byte-code function compiled from such a list, or alternatively a primitive subr-object; names are "extra". Although usually functions are defined with `defun' and given names at the same time, it is occasionally more concise to use an explicit lambda expression--an anonymous function. Such a list is valid wherever a function name is. Any method of creating such a list makes a valid function. Even this: (setq silly (append '(lambda (x)) (list (list '+ (* 3 4) 'x)))) => (lambda (x) (+ 12 x)) This computes a list that looks like `(lambda (x) (+ 12 x))' and makes it the value (*not* the function definition!) of `silly'. Here is how we might call this function: (funcall silly 1) => 13 (It does *not* work to write `(silly 1)', because this function is not the *function definition* of `silly'. We have not given `silly' any function definition, just a value as a variable.) Most of the time, anonymous functions are constants that appear in your program. For example, you might want to pass one as an argument to the function `mapcar', which applies any given function to each element of a list. Here we define a function `change-property' which uses a function as its third argument: (defun change-property (symbol prop function) (let ((value (get symbol prop))) (put symbol prop (funcall function value)))) Here we define a function that uses `change-property', passing it a function to double a number: (defun double-property (symbol prop) (change-property symbol prop '(lambda (x) (* 2 x)))) In such cases, we usually use the special form `function' instead of simple quotation to quote the anonymous function, like this: (defun double-property (symbol prop) (change-property symbol prop (function (lambda (x) (* 2 x))))) Using `function' instead of `quote' makes a difference if you compile the function `double-property'. For example, if you compile the second definition of `double-property', the anonymous function is compiled as well. By contrast, if you compile the first definition which uses ordinary `quote', the argument passed to `change-property' is the precise list shown: (lambda (x) (* x 2)) The Lisp compiler cannot assume this list is a function, even though it looks like one, since it does not know what `change-property' will do with the list. Perhaps it will check whether the CAR of the third element is the symbol `*'! Using `function' tells the compiler it is safe to go ahead and compile the constant function. We sometimes write `function' instead of `quote' when quoting the name of a function, but this usage is just a sort of comment: (function SYMBOL) == (quote SYMBOL) == 'SYMBOL The read syntax `#'' is a short-hand for using `function'. For example, #'(lambda (x) (* x x)) is equivalent to (function (lambda (x) (* x x))) - Special Form: function FUNCTION-OBJECT This special form returns FUNCTION-OBJECT without evaluating it. In this, it is equivalent to `quote'. However, it serves as a note to the Emacs Lisp compiler that FUNCTION-OBJECT is intended to be used only as a function, and therefore can safely be compiled. Contrast this with `quote', in *Note Quoting::. See `documentation' in *Note Accessing Documentation::, for a realistic example using `function' and an anonymous function. Accessing Function Cell Contents ================================ The "function definition" of a symbol is the object stored in the function cell of the symbol. The functions described here access, test, and set the function cell of symbols. See also the function `indirect-function' in *Note Function Indirection::. - Function: symbol-function SYMBOL This returns the object in the function cell of SYMBOL. If the symbol's function cell is void, a `void-function' error is signaled. This function does not check that the returned object is a legitimate function. (defun bar (n) (+ n 2)) => bar (symbol-function 'bar) => (lambda (n) (+ n 2)) (fset 'baz 'bar) => bar (symbol-function 'baz) => bar If you have never given a symbol any function definition, we say that that symbol's function cell is "void". In other words, the function cell does not have any Lisp object in it. If you try to call such a symbol as a function, it signals a `void-function' error. Note that void is not the same as `nil' or the symbol `void'. The symbols `nil' and `void' are Lisp objects, and can be stored into a function cell just as any other object can be (and they can be valid functions if you define them in turn with `defun'). A void function cell contains no object whatsoever. You can test the voidness of a symbol's function definition with `fboundp'. After you have given a symbol a function definition, you can make it void once more using `fmakunbound'. - Function: fboundp SYMBOL This function returns `t' if the symbol has an object in its function cell, `nil' otherwise. It does not check that the object is a legitimate function. - Function: fmakunbound SYMBOL This function makes SYMBOL's function cell void, so that a subsequent attempt to access this cell will cause a `void-function' error. (See also `makunbound', in *Note Void Variables::.) (defun foo (x) x) => foo (foo 1) =>1 (fmakunbound 'foo) => foo (foo 1) error--> Symbol's function definition is void: foo - Function: fset SYMBOL DEFINITION This function stores DEFINITION in the function cell of SYMBOL. The result is DEFINITION. Normally DEFINITION should be a function or the name of a function, but this is not checked. The argument SYMBOL is an ordinary evaluated argument. There are three normal uses of this function: * Copying one symbol's function definition to another--in other words, making an alternate name for a function. (If you think of this as the definition of the new name, you should use `defalias' instead of `fset'; see *Note Defining Functions::.) * Giving a symbol a function definition that is not a list and therefore cannot be made with `defun'. For example, you can use `fset' to give a symbol `s1' a function definition which is another symbol `s2'; then `s1' serves as an alias for whatever definition `s2' presently has. (Once again use `defalias' instead of `fset' if you think of this as the definition of `s1'.) * In constructs for defining or altering functions. If `defun' were not a primitive, it could be written in Lisp (as a macro) using `fset'. Here are examples of these uses: ;; Save `foo''s definition in `old-foo'. (fset 'old-foo (symbol-function 'foo)) ;; Make the symbol `car' the function definition of `xfirst'. ;; (Most likely, `defalias' would be better than `fset' here.) (fset 'xfirst 'car) => car (xfirst '(1 2 3)) => 1 (symbol-function 'xfirst) => car (symbol-function (symbol-function 'xfirst)) => # ;; Define a named keyboard macro. (fset 'kill-two-lines "\^u2\^k") => "\^u2\^k" ;; Here is a function that alters other functions. (defun copy-function-definition (new old) "Define NEW with the same function definition as OLD." (fset new (symbol-function old))) When writing a function that extends a previously defined function, the following idiom is sometimes used: (fset 'old-foo (symbol-function 'foo)) (defun foo () "Just like old-foo, except more so." (old-foo) (more-so)) This does not work properly if `foo' has been defined to autoload. In such a case, when `foo' calls `old-foo', Lisp attempts to define `old-foo' by loading a file. Since this presumably defines `foo' rather than `old-foo', it does not produce the proper results. The only way to avoid this problem is to make sure the file is loaded before moving aside the old definition of `foo'. But it is unmodular and unclean, in any case, for a Lisp file to redefine a function defined elsewhere. It is cleaner to use the advice facility (*note Advising Functions::.). Inline Functions ================ You can define an "inline function" by using `defsubst' instead of `defun'. An inline function works just like an ordinary function except for one thing: when you compile a call to the function, the function's definition is open-coded into the caller. Making a function inline makes explicit calls run faster. But it also has disadvantages. For one thing, it reduces flexibility; if you change the definition of the function, calls already inlined still use the old definition until you recompile them. Since the flexibility of redefining functions is an important feature of Emacs, you should not make a function inline unless its speed is really crucial. Another disadvantage is that making a large function inline can increase the size of compiled code both in files and in memory. Since the speed advantage of inline functions is greatest for small functions, you generally should not make large functions inline. It's possible to define a macro to expand into the same code that an inline function would execute. (*Note Macros::.) But the macro would be limited to direct use in expressions--a macro cannot be called with `apply', `mapcar' and so on. Also, it takes some work to convert an ordinary function into a macro. To convert it into an inline function is very easy; simply replace `defun' with `defsubst'. Since each argument of an inline function is evaluated exactly once, you needn't worry about how many times the body uses the arguments, as you do for macros. (*Note Argument Evaluation::.) Inline functions can be used and open-coded later on in the same file, following the definition, just like macros. Other Topics Related to Functions ================================= Here is a table of several functions that do things related to function calling and function definitions. They are documented elsewhere, but we provide cross references here. `apply' See *Note Calling Functions::. `autoload' See *Note Autoload::. `call-interactively' See *Note Interactive Call::. `commandp' See *Note Interactive Call::. `documentation' See *Note Accessing Documentation::. `eval' See *Note Eval::. `funcall' See *Note Calling Functions::. `function' See *Note Anonymous Functions::. `ignore' See *Note Calling Functions::. `indirect-function' See *Note Function Indirection::. `interactive' See *Note Using Interactive::. `interactive-p' See *Note Interactive Call::. `mapatoms' See *Note Creating Symbols::. `mapcar' See *Note Mapping Functions::. `map-char-table' See *Note Char-Tables::. `mapconcat' See *Note Mapping Functions::. `undefined' See *Note Key Lookup::. Macros ****** "Macros" enable you to define new control constructs and other language features. A macro is defined much like a function, but instead of telling how to compute a value, it tells how to compute another Lisp expression which will in turn compute the value. We call this expression the "expansion" of the macro. Macros can do this because they operate on the unevaluated expressions for the arguments, not on the argument values as functions do. They can therefore construct an expansion containing these argument expressions or parts of them. If you are using a macro to do something an ordinary function could do, just for the sake of speed, consider using an inline function instead. *Note Inline Functions::. A Simple Example of a Macro =========================== Suppose we would like to define a Lisp construct to increment a variable value, much like the `++' operator in C. We would like to write `(inc x)' and have the effect of `(setq x (1+ x))'. Here's a macro definition that does the job: (defmacro inc (var) (list 'setq var (list '1+ var))) When this is called with `(inc x)', the argument VAR is the symbol `x'--*not* the *value* of `x', as it would be in a function. The body of the macro uses this to construct the expansion, which is `(setq x (1+ x))'. Once the macro definition returns this expansion, Lisp proceeds to evaluate it, thus incrementing `x'. Expansion of a Macro Call ========================= A macro call looks just like a function call in that it is a list which starts with the name of the macro. The rest of the elements of the list are the arguments of the macro. Evaluation of the macro call begins like evaluation of a function call except for one crucial difference: the macro arguments are the actual expressions appearing in the macro call. They are not evaluated before they are given to the macro definition. By contrast, the arguments of a function are results of evaluating the elements of the function call list. Having obtained the arguments, Lisp invokes the macro definition just as a function is invoked. The argument variables of the macro are bound to the argument values from the macro call, or to a list of them in the case of a `&rest' argument. And the macro body executes and returns its value just as a function body does. The second crucial difference between macros and functions is that the value returned by the macro body is not the value of the macro call. Instead, it is an alternate expression for computing that value, also known as the "expansion" of the macro. The Lisp interpreter proceeds to evaluate the expansion as soon as it comes back from the macro. Since the expansion is evaluated in the normal manner, it may contain calls to other macros. It may even be a call to the same macro, though this is unusual. You can see the expansion of a given macro call by calling `macroexpand'. - Function: macroexpand FORM &optional ENVIRONMENT This function expands FORM, if it is a macro call. If the result is another macro call, it is expanded in turn, until something which is not a macro call results. That is the value returned by `macroexpand'. If FORM is not a macro call to begin with, it is returned as given. Note that `macroexpand' does not look at the subexpressions of FORM (although some macro definitions may do so). Even if they are macro calls themselves, `macroexpand' does not expand them. The function `macroexpand' does not expand calls to inline functions. Normally there is no need for that, since a call to an inline function is no harder to understand than a call to an ordinary function. If ENVIRONMENT is provided, it specifies an alist of macro definitions that shadow the currently defined macros. Byte compilation uses this feature. (defmacro inc (var) (list 'setq var (list '1+ var))) => inc (macroexpand '(inc r)) => (setq r (1+ r)) (defmacro inc2 (var1 var2) (list 'progn (list 'inc var1) (list 'inc var2))) => inc2 (macroexpand '(inc2 r s)) => (progn (inc r) (inc s)) ; `inc' not expanded here. Macros and Byte Compilation =========================== You might ask why we take the trouble to compute an expansion for a macro and then evaluate the expansion. Why not have the macro body produce the desired results directly? The reason has to do with compilation. When a macro call appears in a Lisp program being compiled, the Lisp compiler calls the macro definition just as the interpreter would, and receives an expansion. But instead of evaluating this expansion, it compiles the expansion as if it had appeared directly in the program. As a result, the compiled code produces the value and side effects intended for the macro, but executes at full compiled speed. This would not work if the macro body computed the value and side effects itself--they would be computed at compile time, which is not useful. In order for compilation of macro calls to work, the macros must already be defined in Lisp when the calls to them are compiled. The compiler has a special feature to help you do this: if a file being compiled contains a `defmacro' form, the macro is defined temporarily for the rest of the compilation of that file. To make this feature work, you must put the `defmacro' in the same file where it is used, and before its first use. Byte-compiling a file executes any `require' calls at top-level in the file. This is in case the file needs the required packages for proper compilation. One way to ensure that necessary macro definitions are available during compilation is to require the files that define them (*note Named Features::.). To avoid loading the macro definition files when someone *runs* the compiled program, write `eval-when-compile' around the `require' calls (*note Eval During Compile::.). Defining Macros =============== A Lisp macro is a list whose CAR is `macro'. Its CDR should be a function; expansion of the macro works by applying the function (with `apply') to the list of unevaluated argument-expressions from the macro call. It is possible to use an anonymous Lisp macro just like an anonymous function, but this is never done, because it does not make sense to pass an anonymous macro to functionals such as `mapcar'. In practice, all Lisp macros have names, and they are usually defined with the special form `defmacro'. - Special Form: defmacro NAME ARGUMENT-LIST BODY-FORMS... `defmacro' defines the symbol NAME as a macro that looks like this: (macro lambda ARGUMENT-LIST . BODY-FORMS) (Note that the CDR of this list is a function--a lambda expression.) This macro object is stored in the function cell of NAME. The value returned by evaluating the `defmacro' form is NAME, but usually we ignore this value. The shape and meaning of ARGUMENT-LIST is the same as in a function, and the keywords `&rest' and `&optional' may be used (*note Argument List::.). Macros may have a documentation string, but any `interactive' declaration is ignored since macros cannot be called interactively. Backquote ========= Macros often need to construct large list structures from a mixture of constants and nonconstant parts. To make this easier, use the ``' syntax (usually called "backquote"). Backquote allows you to quote a list, but selectively evaluate elements of that list. In the simplest case, it is identical to the special form `quote' (*note Quoting::.). For example, these two forms yield identical results: `(a list of (+ 2 3) elements) => (a list of (+ 2 3) elements) '(a list of (+ 2 3) elements) => (a list of (+ 2 3) elements) The special marker `,' inside of the argument to backquote indicates a value that isn't constant. Backquote evaluates the argument of `,' and puts the value in the list structure: (list 'a 'list 'of (+ 2 3) 'elements) => (a list of 5 elements) `(a list of ,(+ 2 3) elements) => (a list of 5 elements) Substitution with `,' is allowed at deeper levels of the list structure also. For example: (defmacro t-becomes-nil (variable) `(if (eq ,variable t) (setq ,variable nil))) (t-becomes-nil foo) == (if (eq foo t) (setq foo nil)) You can also "splice" an evaluated value into the resulting list, using the special marker `,@'. The elements of the spliced list become elements at the same level as the other elements of the resulting list. The equivalent code without using ``' is often unreadable. Here are some examples: (setq some-list '(2 3)) => (2 3) (cons 1 (append some-list '(4) some-list)) => (1 2 3 4 2 3) `(1 ,@some-list 4 ,@some-list) => (1 2 3 4 2 3) (setq list '(hack foo bar)) => (hack foo bar) (cons 'use (cons 'the (cons 'words (append (cdr list) '(as elements))))) => (use the words foo bar as elements) `(use the words ,@(cdr list) as elements) => (use the words foo bar as elements) In old Emacs versions, before version 19.29, ``' used a different syntax which required an extra level of parentheses around the entire backquote construct. Likewise, each `,' or `,@' substitution required an extra level of parentheses surrounding both the `,' or `,@' and the following expression. The old syntax required whitespace between the ``', `,' or `,@' and the following expression. This syntax is still accepted, for compatibility with old Emacs versions, but we recommend not using it in new programs. Common Problems Using Macros ============================ The basic facts of macro expansion have counterintuitive consequences. This section describes some important consequences that can lead to trouble, and rules to follow to avoid trouble. Evaluating Macro Arguments Repeatedly ------------------------------------- When defining a macro you must pay attention to the number of times the arguments will be evaluated when the expansion is executed. The following macro (used to facilitate iteration) illustrates the problem. This macro allows us to write a simple "for" loop such as one might find in Pascal. (defmacro for (var from init to final do &rest body) "Execute a simple \"for\" loop. For example, (for i from 1 to 10 do (print i))." (list 'let (list (list var init)) (cons 'while (cons (list '<= var final) (append body (list (list 'inc var))))))) => for (for i from 1 to 3 do (setq square (* i i)) (princ (format "\n%d %d" i square))) ==> (let ((i 1)) (while (<= i 3) (setq square (* i i)) (princ (format "%d %d" i square)) (inc i))) -|1 1 -|2 4 -|3 9 => nil The arguments `from', `to', and `do' in this macro are "syntactic sugar"; they are entirely ignored. The idea is that you will write noise words (such as `from', `to', and `do') in those positions in the macro call. Here's an equivalent definition simplified through use of backquote: (defmacro for (var from init to final do &rest body) "Execute a simple \"for\" loop. For example, (for i from 1 to 10 do (print i))." `(let ((,var ,init)) (while (<= ,var ,final) ,@body (inc ,var)))) Both forms of this definition (with backquote and without) suffer from the defect that FINAL is evaluated on every iteration. If FINAL is a constant, this is not a problem. If it is a more complex form, say `(long-complex-calculation x)', this can slow down the execution significantly. If FINAL has side effects, executing it more than once is probably incorrect. A well-designed macro definition takes steps to avoid this problem by producing an expansion that evaluates the argument expressions exactly once unless repeated evaluation is part of the intended purpose of the macro. Here is a correct expansion for the `for' macro: (let ((i 1) (max 3)) (while (<= i max) (setq square (* i i)) (princ (format "%d %d" i square)) (inc i))) Here is a macro definition that creates this expansion: (defmacro for (var from init to final do &rest body) "Execute a simple for loop: (for i from 1 to 10 do (print i))." `(let ((,var ,init) (max ,final)) (while (<= ,var max) ,@body (inc ,var)))) Unfortunately, this fix introduces another problem, described in the following section. Local Variables in Macro Expansions ----------------------------------- In the previous section, the definition of `for' was fixed as follows to make the expansion evaluate the macro arguments the proper number of times: (defmacro for (var from init to final do &rest body) "Execute a simple for loop: (for i from 1 to 10 do (print i))." `(let ((,var ,init) (max ,final)) (while (<= ,var max) ,@body (inc ,var)))) The new definition of `for' has a new problem: it introduces a local variable named `max' which the user does not expect. This causes trouble in examples such as the following: (let ((max 0)) (for x from 0 to 10 do (let ((this (frob x))) (if (< max this) (setq max this))))) The references to `max' inside the body of the `for', which are supposed to refer to the user's binding of `max', really access the binding made by `for'. The way to correct this is to use an uninterned symbol instead of `max' (*note Creating Symbols::.). The uninterned symbol can be bound and referred to just like any other symbol, but since it is created by `for', we know that it cannot already appear in the user's program. Since it is not interned, there is no way the user can put it into the program later. It will never appear anywhere except where put by `for'. Here is a definition of `for' that works this way: (defmacro for (var from init to final do &rest body) "Execute a simple for loop: (for i from 1 to 10 do (print i))." (let ((tempvar (make-symbol "max"))) `(let ((,var ,init) (,tempvar ,final)) (while (<= ,var ,tempvar) ,@body (inc ,var))))) This creates an uninterned symbol named `max' and puts it in the expansion instead of the usual interned symbol `max' that appears in expressions ordinarily. Evaluating Macro Arguments in Expansion --------------------------------------- Another problem can happen if the macro definition itself evaluates any of the macro argument expressions, such as by calling `eval' (*note Eval::.). If the argument is supposed to refer to the user's variables, you may have trouble if the user happens to use a variable with the same name as one of the macro arguments. Inside the macro body, the macro argument binding is the most local binding of this variable, so any references inside the form being evaluated do refer to it. Here is an example: (defmacro foo (a) (list 'setq (eval a) t)) => foo (setq x 'b) (foo x) ==> (setq b t) => t ; and `b' has been set. ;; but (setq a 'c) (foo a) ==> (setq a t) => t ; but this set `a', not `c'. It makes a difference whether the user's variable is named `a' or `x', because `a' conflicts with the macro argument variable `a'. Another problem with calling `eval' in a macro definition is that it probably won't do what you intend in a compiled program. The byte-compiler runs macro definitions while compiling the program, when the program's own computations (which you might have wished to access with `eval') don't occur and its local variable bindings don't exist. To avoid these problems, *don't evaluate an argument expression while computing the macro expansion*. Instead, substitute the expression into the macro expansion, so that its value will be computed as part of executing the expansion. This is how the other examples in this chapter work. How Many Times is the Macro Expanded? ------------------------------------- Occasionally problems result from the fact that a macro call is expanded each time it is evaluated in an interpreted function, but is expanded only once (during compilation) for a compiled function. If the macro definition has side effects, they will work differently depending on how many times the macro is expanded. Therefore, you should avoid side effects in computation of the macro expansion, unless you really know what you are doing. One special kind of side effect can't be avoided: constructing Lisp objects. Almost all macro expansions include constructed lists; that is the whole point of most macros. This is usually safe; there is just one case where you must be careful: when the object you construct is part of a quoted constant in the macro expansion. If the macro is expanded just once, in compilation, then the object is constructed just once, during compilation. But in interpreted execution, the macro is expanded each time the macro call runs, and this means a new object is constructed each time. In most clean Lisp code, this difference won't matter. It can matter only if you perform side-effects on the objects constructed by the macro definition. Thus, to avoid trouble, *avoid side effects on objects constructed by macro definitions*. Here is an example of how such side effects can get you into trouble: (defmacro empty-object () (list 'quote (cons nil nil))) (defun initialize (condition) (let ((object (empty-object))) (if condition (setcar object condition)) object)) If `initialize' is interpreted, a new list `(nil)' is constructed each time `initialize' is called. Thus, no side effect survives between calls. If `initialize' is compiled, then the macro `empty-object' is expanded during compilation, producing a single "constant" `(nil)' that is reused and altered each time `initialize' is called. One way to avoid pathological cases like this is to think of `empty-object' as a funny kind of constant, not as a memory allocation construct. You wouldn't use `setcar' on a constant such as `'(nil)', so naturally you won't use it on `(empty-object)' either. Writing Customization Definitions ********************************* This chapter describes how to declare user options for customization, and also customization groups for classifying them. We use the term "customization item" to include both kinds of customization definitions--as well as face definitions (*note Defining Faces::.). Common Keywords for All Kinds of Items ====================================== All kinds of customization declarations (for variables and groups, and for faces) accept keyword arguments for specifying various information. This section describes some keywords that apply to all kinds. All of these keywords, except `:tag', can be used more than once in a given item. Each use of the keyword has an independent effect. The keyword `:tag' is an exception because any given item can only display one name. `:tag NAME' Use NAME, a string, instead of the item's name, to label the item in customization menus and buffers. `:group GROUP' Put this customization item in group GROUP. When you use `:group' in a `defgroup', it makes the new group a subgroup of GROUP. If you use this keyword more than once, you can put a single item into more than one group. Displaying any of those groups will show this item. Be careful not to overdo this! `:link LINK-DATA' Include an external link after the documentation string for this item. This is a sentence containing an active field which references some other documentation. There are three alternatives you can use for LINK-DATA: `(custom-manual INFO-NODE)' Link to an Info node; INFO-NODE is a string which specifies the node name, as in `"(emacs)Top"'. The link appears as `[manual]' in the customization buffer. `(info-link INFO-NODE)' Like `custom-manual' except that the link appears in the customization buffer with the Info node name. `(url-link URL)' Link to a web page; URL is a string which specifies the URL. The link appears in the customization buffer as URL. You can specify the text to use in the customization buffer by adding `:tag NAME' after the first element of the LINK-DATA; for example, `(info-link :tag "foo" "(emacs)Top")' makes a link to the Emacs manual which appears in the buffer as `foo'. An item can have more than one external link; however, most items have none at all. `:load FILE' Load file FILE (a string) before displaying this customization item. Loading is done with `load-library', and only if the file is not already loaded. `:require FEATURE' Require feature FEATURE (a symbol) when installing a value for this item (an option or a face) that was saved using the customization feature. This is done by calling `require'. The most common reason to use `:require' is when a variable enables a feature such as a minor mode, and just setting the variable won't have any effect unless the code which implements the mode is loaded. Defining Custom Groups ====================== Each Emacs Lisp package should have one main customization group which contains all the options, faces and other groups in the package. If the package has a small number of options and faces, use just one group and put everything in it. When there are more than twelve or so options and faces, then you should structure them into subgroups, and put the subgroups under the package's main customization group. It is OK to put some of the options and faces in the package's main group alongside the subgroups. The package's main or only group should be a member of one or more of the standard customization groups. (To display the full list of them, use `M-x customize'.) Choose one or more of them (but not too many), and add your group to each of them using the `:group' keyword. The way to declare new customization groups is with `defgroup'. - Macro: defgroup GROUP MEMBERS DOC [KEYWORD VALUE]... Declare GROUP as a customization group containing MEMBERS. Do not quote the symbol GROUP. The argument DOC specifies the documentation string for the group. The argument MEMBERS is a list specifying an initial set of customization items to be members of the group. However, most often MEMBERS is `nil', and you specify the group's members by using the `:group' keyword when defining those members. If you want to specify group members through MEMBERS, each element should have the form `(NAME WIDGET)'. Here NAME is a symbol, and WIDGET is a widget type for editing that symbol. Useful widgets are `custom-variable' for a variable, `custom-face' for a face, and `custom-group' for a group. In addition to the common keywords (*note Common Keywords::.), you can use this keyword in `defgroup': `:prefix PREFIX' If the name of an item in the group starts with PREFIX, then the tag for that item is constructed (by default) by omitting PREFIX. One group can have any number of prefixes. The prefix-discarding feature is currently turned off, which means that `:prefix' currently has no effect. We did this because we found that discarding the specified prefixes often led to confusing names for options. This happened because the people who wrote the `defgroup' definitions for various groups added `:prefix' keywords whenever they make logical sense--that is, whenever the variables in the library have a common prefix. In order to obtain good results with `:prefix', it would be necessary to check the specific effects of discarding a particular prefix, given the specific items in a group and their names and documentation. If the resulting text is not clear, then `:prefix' should not be used in that case. It should be possible to recheck all the customization groups, delete the `:prefix' specifications which give unclear results, and then turn this feature back on, if someone would like to do the work. Defining Customization Variables ================================ Use `defcustom' to declare user-editable variables. - Macro: defcustom OPTION DEFAULT DOC [KEYWORD VALUE]... Declare OPTION as a customizable user option variable. Do not quote OPTION. The argument DOC specifies the documentation string for the variable. If OPTION is void, `defcustom' initializes it to DEFAULT. DEFAULT should be an expression to compute the value; be careful in writing it, because it can be evaluated on more than one occasion. `defcustom' accepts the following additional keywords: `:type TYPE' Use TYPE as the data type for this option. It specifies which values are legitimate, and how to display the value. *Note Customization Types::, for more information. `:options LIST' Specify LIST as the list of reasonable values for use in this option. Currently this is meaningful only when the type is `hook'. In that case, the elements of LIST should be functions that are useful as elements of the hook value. The user is not restricted to using only these functions, but they are offered as convenient alternatives. `:version VERSION' This option specifies that the variable was first introduced, or its default value was changed, in Emacs version VERSION. The value VERSION must be a string. For example, (defcustom foo-max 34 "*Maximum number of foo's allowed." :type 'integer :group 'foo :version "20.3") `:set SETFUNCTION' Specify SETFUNCTION as the way to change the value of this option. The function SETFUNCTION should take two arguments, a symbol and the new value, and should do whatever is necessary to update the value properly for this option (which may not mean simply setting the option as a Lisp variable). The default for SETFUNCTION is `set-default'. `:get GETFUNCTION' Specify GETFUNCTION as the way to extract the value of this option. The function GETFUNCTION should take one argument, a symbol, and should return the "current value" for that symbol (which need not be the symbol's Lisp value). The default is `default-value'. `:initialize FUNCTION' FUNCTION should be a function used to initialize the variable when the `defcustom' is evaluated. It should take two arguments, the symbol and value. Here are some predefined functions meant for use in this way: `custom-initialize-set' Use the variable's `:set' function to initialize the variable, but do not reinitialize it if it is already non-void. This is the default `:initialize' function. `custom-initialize-default' Like `custom-initialize-set', but use the function `set-default' to set the variable, instead of the variable's `:set' function. This is the usual choice for a variable whose `:set' function enables or disables a minor mode; with this choice, defining the variable will not call the minor mode function, but customizing the variable will do so. `custom-initialize-reset' Always use the `:set' function to initialize the variable. If the variable is already non-void, reset it by calling the `:set' function using the current value (returned by the `:get' method). `custom-initialize-changed' Use the `:set' function to initialize the variable, if it is already set or has been customized; otherwise, just use `set-default'. The `:require' option is useful for an option that turns on the operation of a certain feature. Assuming that the package is coded to check the value of the option, you still need to arrange for the package to be loaded. You can do that with `:require'. *Note Common Keywords::. Here is an example, from the library `paren.el': (defcustom show-paren-mode nil "Toggle Show Paren mode...." :set (lambda (symbol value) (show-paren-mode (or value 0))) :initialize 'custom-initialize-default :type 'boolean :group 'paren-showing :require 'paren) Internally, `defcustom' uses the symbol property `standard-value' to record the expression for the default value, and `saved-value' to record the value saved by the user with the customization buffer. The `saved-value' property is actually a list whose car is an expression which evaluates to the value. Customization Types =================== When you define a user option with `defcustom', you must specify its "customization type". That is a Lisp object which describes (1) which values are legitimate and (2) how to display the value in the customization buffer for editing. You specify the customization type in `defcustom' with the `:type' keyword. The argument of `:type' is evaluated; since types that vary at run time are rarely useful, normally you use a quoted constant. For example: (defcustom diff-command "diff" "*The command to use to run diff." :type '(string) :group 'diff) In general, a customization type is a list whose first element is a symbol, one of the customization type names defined in the following sections. After this symbol come a number of arguments, depending on the symbol. Between the type symbol and its arguments, you can optionally write keyword-value pairs (*note Type Keywords::.). Some of the type symbols do not use any arguments; those are called "simple types". For a simple type, if you do not use any keyword-value pairs, you can omit the parentheses around the type symbol. For example just `string' as a customization type is equivalent to `(string)'. Simple Types ------------ This section describes all the simple customization types. `sexp' The value may be any Lisp object that can be printed and read back. You can use `sexp' as a fall-back for any option, if you don't want to take the time to work out a more specific type to use. `integer' The value must be an integer, and is represented textually in the customization buffer. `number' The value must be a number, and is represented textually in the customization buffer. `string' The value must be a string, and the customization buffer shows just the contents, with no delimiting `"' characters and no quoting with `\'. `regexp' Like `string' except that the string must be a valid regular expression. `character' The value must be a character code. A character code is actually an integer, but this type shows the value by inserting the character in the buffer, rather than by showing the number. `file' The value must be a file name, and you can do completion with `M-'. `(file :must-match t)' The value must be a file name for an existing file, and you can do completion with `M-'. `directory' The value must be a directory name, and you can do completion with `M-'. `hook' The value must be a list of functions (or a single function, but that is obsolete usage). This customization type is used for hook variables. You can use the `:options' keyword in a hook variable's `defcustom' to specify a list of functions recommended for use in the hook; see *Note Variable Definitions::. `symbol' The value must be a symbol. It appears in the customization buffer as the name of the symbol. `function' The value must be either a lambda expression or a function name. When it is a function name, you can do completion with `M-'. `variable' The value must be a variable name, and you can do completion with `M-'. `face' The value must be a symbol which is a face name, and you can do completion with `M-'. `boolean' The value is boolean--either `nil' or `t'. Note that by using `choice' and `const' together (see the next section), you can specify that the value must be `nil' or `t', but also specify the text to describe each value in a way that fits the specific meaning of the alternative. Composite Types --------------- When none of the simple types is appropriate, you can use composite types, which build new types from other types. Here are several ways of doing that: `(restricted-sexp :match-alternatives CRITERIA)' The value may be any Lisp object that satisfies one of CRITERIA. CRITERIA should be a list, and each element should be one of these possibilities: * A predicate--that is, a function of one argument that has no side effects, and returns either `nil' or non-`nil' according to the argument. Using a predicate in the list says that objects for which the predicate returns non-`nil' are acceptable. * A quoted constant--that is, `'OBJECT'. This sort of element in the list says that OBJECT itself is an acceptable value. For example, (restricted-sexp :match-alternatives (integerp 't 'nil)) allows integers, `t' and `nil' as legitimate values. The customization buffer shows all legitimate values using their read syntax, and the user edits them textually. `(cons CAR-TYPE CDR-TYPE)' The value must be a cons cell, its CAR must fit CAR-TYPE, and its CDR must fit CDR-TYPE. For example, `(cons string symbol)' is a customization type which matches values such as `("foo" . foo)'. In the customization buffer, the CAR and the CDR are displayed and edited separately, each according to the type that you specify for it. `(list ELEMENT-TYPES...)' The value must be a list with exactly as many elements as the ELEMENT-TYPES you have specified; and each element must fit the corresponding ELEMENT-TYPE. For example, `(list integer string function)' describes a list of three elements; the first element must be an integer, the second a string, and the third a function. In the customization buffer, each element is displayed and edited separately, according to the type specified for it. `(vector ELEMENT-TYPES...)' Like `list' except that the value must be a vector instead of a list. The elements work the same as in `list'. `(choice ALTERNATIVE-TYPES...)' The value must fit at least one of ALTERNATIVE-TYPES. For example, `(choice integer string)' allows either an integer or a string. In the customization buffer, the user selects one of the alternatives using a menu, and can then edit the value in the usual way for that alternative. Normally the strings in this menu are determined automatically from the choices; however, you can specify different strings for the menu by including the `:tag' keyword in the alternatives. For example, if an integer stands for a number of spaces, while a string is text to use verbatim, you might write the customization type this way, (choice (integer :tag "Number of spaces") (string :tag "Literal text")) so that the menu offers `Number of spaces' and `Literal Text'. In any alternative for which `nil' is not a valid value, other than a `const', you should specify a valid default for that alternative using the `:value' keyword. *Note Type Keywords::. `(const VALUE)' The value must be VALUE--nothing else is allowed. The main use of `const' is inside of `choice'. For example, `(choice integer (const nil))' allows either an integer or `nil'. `:tag' is often used with `const', inside of `choice'. For example, (choice (const :tag "Yes" t) (const :tag "No" nil) (const :tag "Ask" foo)) describes a variable for which `t' means yes, `nil' means no, and `foo' means "ask." `(other VALUE)' This alternative can match any Lisp value, but if the user chooses this alternative, that selects the value VALUE. The main use of `other' is as the last element of `choice'. For example, (choice (const :tag "Yes" t) (const :tag "No" nil) (other :tag "Ask" foo)) describes a variable for which `t' means yes, `nil' means no, and anything else means "ask." If the user chooses `Ask' from the menu of alternatives, that specifies the value `foo'; but any other value (not `t', `nil' or `foo') displays as `Ask', just like `foo'. `(function-item FUNCTION)' Like `const', but used for values which are functions. This displays the documentation string as well as the function name. The documentation string is either the one you specify with `:doc', or FUNCTION's own documentation string. `(variable-item VARIABLE)' Like `const', but used for values which are variable names. This displays the documentation string as well as the variable name. The documentation string is either the one you specify with `:doc', or VARIABLE's own documentation string. `(set ELEMENTS...)' The value must be a list and each element of the list must be one of the ELEMENTS specified. This appears in the customization buffer as a checklist. `(repeat ELEMENT-TYPE)' The value must be a list and each element of the list must fit the type ELEMENT-TYPE. This appears in the customization buffer as a list of elements, with `[INS]' and `[DEL]' buttons for adding more elements or removing elements. Splicing into Lists ------------------- The `:inline' feature lets you splice a variable number of elements into the middle of a list or vector. You use it in a `set', `choice' or `repeat' type which appears among the element-types of a `list' or `vector'. Normally, each of the element-types in a `list' or `vector' describes one and only one element of the list or vector. Thus, if an element-type is a `repeat', that specifies a list of unspecified length which appears as one element. But when the element-type uses `:inline', the value it matches is merged directly into the containing sequence. For example, if it matches a list with three elements, those become three elements of the overall sequence. This is analogous to using `,@' in the backquote construct. For example, to specify a list whose first element must be `t' and whose remaining arguments should be zero or more of `foo' and `bar', use this customization type: (list (const t) (set :inline t foo bar)) This matches values such as `(t)', `(t foo)', `(t bar)' and `(t foo bar)'. When the element-type is a `choice', you use `:inline' not in the `choice' itself, but in (some of) the alternatives of the `choice'. For example, to match a list which must start with a file name, followed either by the symbol `t' or two strings, use this customization type: (list file (choice (const t) (list :inline t string string))) If the user chooses the first alternative in the choice, then the overall list has two elements and the second element is `t'. If the user chooses the second alternative, then the overall list has three elements and the second and third must be strings. Type Keywords ------------- You can specify keyword-argument pairs in a customization type after the type name symbol. Here are the keywords you can use, and their meanings: `:value DEFAULT' This is used for a type that appears as an alternative inside of `choice'; it specifies the default value to use, at first, if and when the user selects this alternative with the menu in the customization buffer. Of course, if the actual value of the option fits this alternative, it will appear showing the actual value, not DEFAULT. If `nil' is not a valid value for the alternative, then it is essential to specify a valid default with `:value'. `:format FORMAT-STRING' This string will be inserted in the buffer to represent the value corresponding to the type. The following `%' escapes are available for use in FORMAT-STRING: `%[BUTTON%]' Display the text BUTTON marked as a button. The `:action' attribute specifies what the button will do if the user invokes it; its value is a function which takes two arguments--the widget which the button appears in, and the event. There is no way to specify two different buttons with different actions. `%{SAMPLE%}' Show SAMPLE in a special face specified by `:sample-face'. `%v' Substitute the item's value. How the value is represented depends on the kind of item, and (for variables) on the customization type. `%d' Substitute the item's documentation string. `%h' Like `%d', but if the documentation string is more than one line, add an active field to control whether to show all of it or just the first line. `%t' Substitute the tag here. You specify the tag with the `:tag' keyword. `%%' Display a literal `%'. `:action ACTION' Perform ACTION if the user clicks on a button. `:button-face FACE' Use the face FACE (a face name or a list of face names) for button text displayed with `%[...%]'. `:button-prefix PREFIX' `:button-suffix SUFFIX' These specify the text to display before and after a button. Each can be: `nil' No text is inserted. a string The string is inserted literally. a symbol The symbol's value is used. `:tag TAG' Use TAG (a string) as the tag for the value (or part of the value) that corresponds to this type. `:doc DOC' Use DOC as the documentation string for this value (or part of the value) that corresponds to this type. In order for this to work, you must specify a value for `:format', and use `%d' or `%h' in that value. The usual reason to specify a documentation string for a type is to provide more information about the meanings of alternatives inside a `:choice' type or the parts of some other composite type. `:help-echo MOTION-DOC' When you move to this item with `widget-forward' or `widget-backward', it will display the string MOTION-DOC in the echo area. `:match FUNCTION' Specify how to decide whether a value matches the type. The corresponding value, FUNCTION, should be a function that accepts two arguments, a widget and a value; it should return non-`nil' if the value is acceptable. Loading ******* Loading a file of Lisp code means bringing its contents into the Lisp environment in the form of Lisp objects. Emacs finds and opens the file, reads the text, evaluates each form, and then closes the file. The load functions evaluate all the expressions in a file just as the `eval-current-buffer' function evaluates all the expressions in a buffer. The difference is that the load functions read and evaluate the text in the file as found on disk, not the text in an Emacs buffer. The loaded file must contain Lisp expressions, either as source code or as byte-compiled code. Each form in the file is called a "top-level form". There is no special format for the forms in a loadable file; any form in a file may equally well be typed directly into a buffer and evaluated there. (Indeed, most code is tested this way.) Most often, the forms are function definitions and variable definitions. A file containing Lisp code is often called a "library". Thus, the "Rmail library" is a file containing code for Rmail mode. Similarly, a "Lisp library directory" is a directory of files containing Lisp code. How Programs Do Loading ======================= Emacs Lisp has several interfaces for loading. For example, `autoload' creates a placeholder object for a function defined in a file; trying to call the autoloading function loads the file to get the function's real definition (*note Autoload::.). `require' loads a file if it isn't already loaded (*note Named Features::.). Ultimately, all these facilities call the `load' function to do the work. - Function: load FILENAME &optional MISSING-OK NOMESSAGE NOSUFFIX MUST-SUFFIX This function finds and opens a file of Lisp code, evaluates all the forms in it, and closes the file. To find the file, `load' first looks for a file named `FILENAME.elc', that is, for a file whose name is FILENAME with `.elc' appended. If such a file exists, it is loaded. If there is no file by that name, then `load' looks for a file named `FILENAME.el'. If that file exists, it is loaded. Finally, if neither of those names is found, `load' looks for a file named FILENAME with nothing appended, and loads it if it exists. (The `load' function is not clever about looking at FILENAME. In the perverse case of a file named `foo.el.el', evaluation of `(load "foo.el")' will indeed find it.) If the optional argument NOSUFFIX is non-`nil', then the suffixes `.elc' and `.el' are not tried. In this case, you must specify the precise file name you want. By specifying the precise file name and using `t' for NOSUFFIX, you can prevent perverse file names such as `foo.el.el' from being tried. If the optional argument MUST-SUFFIX is non-`nil', then `load' insists that the file name used must end in either `.el' or `.elc', unless it contains an explicit directory name. If FILENAME does not contain an explicit directory name, and does not end in a suffix, then `load' insists on adding one. If FILENAME is a relative file name, such as `foo' or `baz/foo.bar', `load' searches for the file using the variable `load-path'. It appends FILENAME to each of the directories listed in `load-path', and loads the first file it finds whose name matches. The current default directory is tried only if it is specified in `load-path', where `nil' stands for the default directory. `load' tries all three possible suffixes in the first directory in `load-path', then all three suffixes in the second directory, and so on. *Note Library Search::. If you get a warning that `foo.elc' is older than `foo.el', it means you should consider recompiling `foo.el'. *Note Byte Compilation::. When loading a source file (not compiled), `load' performs character set translation just as Emacs would do when visiting the file. *Note Coding Systems::. Messages like `Loading foo...' and `Loading foo...done' appear in the echo area during loading unless NOMESSAGE is non-`nil'. Any unhandled errors while loading a file terminate loading. If the load was done for the sake of `autoload', any function definitions made during the loading are undone. If `load' can't find the file to load, then normally it signals the error `file-error' (with `Cannot open load file FILENAME'). But if MISSING-OK is non-`nil', then `load' just returns `nil'. You can use the variable `load-read-function' to specify a function for `load' to use instead of `read' for reading expressions. See below. `load' returns `t' if the file loads successfully. - Command: load-file FILENAME This command loads the file FILENAME. If FILENAME is a relative file name, then the current default directory is assumed. `load-path' is not used, and suffixes are not appended. Use this command if you wish to specify precisely the file name to load. - Command: load-library LIBRARY This command loads the library named LIBRARY. It is equivalent to `load', except in how it reads its argument interactively. - Variable: load-in-progress This variable is non-`nil' if Emacs is in the process of loading a file, and it is `nil' otherwise. - Variable: load-read-function This variable specifies an alternate expression-reading function for `load' and `eval-region' to use instead of `read'. The function should accept one argument, just as `read' does. Normally, the variable's value is `nil', which means those functions should use `read'. *Note:* Instead of using this variable, it is cleaner to use another, newer feature: to pass the function as the READ-FUNCTION argument to `eval-region'. *Note Eval::. For information about how `load' is used in building Emacs, see *Note Building Emacs::. Library Search ============== When Emacs loads a Lisp library, it searches for the library in a list of directories specified by the variable `load-path'. - User Option: load-path The value of this variable is a list of directories to search when loading files with `load'. Each element is a string (which must be a directory name) or `nil' (which stands for the current working directory). The value of `load-path' is initialized from the environment variable `EMACSLOADPATH', if that exists; otherwise its default value is specified in `emacs/src/paths.h' when Emacs is built. Then the list is expanded by adding subdirectories of the directories in the list. The syntax of `EMACSLOADPATH' is the same as used for `PATH'; `:' (or `;', according to the operating system) separates directory names, and `.' is used for the current default directory. Here is an example of how to set your `EMACSLOADPATH' variable from a `csh' `.login' file: setenv EMACSLOADPATH .:/user/bil/emacs:/usr/local/share/emacs/20.3/lisp Here is how to set it using `sh': export EMACSLOADPATH EMACSLOADPATH=.:/user/bil/emacs:/usr/local/share/emacs/20.3/lisp Here is an example of code you can place in a `.emacs' file to add several directories to the front of your default `load-path': (setq load-path (append (list nil "/user/bil/emacs" "/usr/local/lisplib" "~/emacs") load-path)) In this example, the path searches the current working directory first, followed then by the `/user/bil/emacs' directory, the `/usr/local/lisplib' directory, and the `~/emacs' directory, which are then followed by the standard directories for Lisp code. Dumping Emacs uses a special value of `load-path'. If the value of `load-path' at the end of dumping is unchanged (that is, still the same special value), the dumped Emacs switches to the ordinary `load-path' value when it starts up, as described above. But if `load-path' has any other value at the end of dumping, that value is used for execution of the dumped Emacs also. Therefore, if you want to change `load-path' temporarily for loading a few libraries in `site-init.el' or `site-load.el', you should bind `load-path' locally with `let' around the calls to `load'. The default value of `load-path', when running an Emacs which has been installed on the system, includes two special directories (and their subdirectories as well): "/usr/local/share/emacs/VERSION/site-lisp" and "/usr/local/share/emacs/site-lisp" The first one is for locally installed packages for a particular Emacs version; the second is for locally installed packages meant for use with all installed Emacs versions. There are several reasons why a Lisp package that works well in one Emacs version can cause trouble in another. Sometimes packages need updating for incompatible changes in Emacs; sometimes they depend on undocumented internal Emacs data that can change without notice; sometimes a newer Emacs version incorporates a version of the package, and should be used only with that version. Emacs finds these directories' subdirectories and adds them to `load-path' when it starts up. Both immediate subdirectories and subdirectories multiple levels down are added to `load-path'. Not all subdirectories are included, though. Subdirectories whose names do not start with a letter or digit are excluded. Subdirectories named `RCS' are excluded. Also, a subdirectory which contains a file named `.nosearch' is excluded. You can use these methods to prevent certain subdirectories of the `site-lisp' directories from being searched. If you run Emacs from the directory where it was built--that is, an executable that has not been formally installed--then `load-path' normally contains two additional directories. These are the `lisp' and `site-lisp' subdirectories of the main build directory. (Both are represented as absolute file names.) - Command: locate-library LIBRARY &optional NOSUFFIX PATH INTERACTIVE-CALL This command finds the precise file name for library LIBRARY. It searches for the library in the same way `load' does, and the argument NOSUFFIX has the same meaning as in `load': don't add suffixes `.elc' or `.el' to the specified name LIBRARY. If the PATH is non-`nil', that list of directories is used instead of `load-path'. When `locate-library' is called from a program, it returns the file name as a string. When the user runs `locate-library' interactively, the argument INTERACTIVE-CALL is `t', and this tells `locate-library' to display the file name in the echo area. Loading Non-ASCII Characters ============================ When Emacs Lisp programs contain string constants with non-ASCII characters, these can be represented within Emacs either as unibyte strings or as multibyte strings (*note Text Representations::.). Which representation is used depends on how the file is read into Emacs. If it is read with decoding into multibyte representation, the text of the Lisp program will be multibyte text, and its string constants will be multibyte strings. If a file containing Latin-1 characters (for example) is read without decoding, the text of the program will be unibyte text, and its string constants will be unibyte strings. *Note Coding Systems::. To make the results more predictable, Emacs always performs decoding into the multibyte representation when loading Lisp files, even if it was started with the `--unibyte' option. This means that string constants with non-ASCII characters translate into multibyte strings. The only exception is when a particular file specifies no decoding. The reason Emacs is designed this way is so that Lisp programs give predictable results, regardless of how Emacs was started. In addition, this enables programs that depend on using multibyte text to work even in a unibyte Emacs. Of course, such programs should be designed to notice whether the user prefers unibyte or multibyte text, by checking `default-enable-multibyte-characters', and convert representations appropriately. In most Emacs Lisp programs, the fact that non-ASCII strings are multibyte strings should not be noticeable, since inserting them in unibyte buffers converts them to unibyte automatically. However, if this does make a difference, you can force a particular Lisp file to be interpreted as unibyte by writing `-*-unibyte: t;-*-' in a comment on the file's first line. With that designator, the file will be unconditionally be interpreted as unibyte, even in an ordinary multibyte Emacs session. Autoload ======== The "autoload" facility allows you to make a function or macro known in Lisp, but put off loading the file that defines it. The first call to the function automatically reads the proper file to install the real definition and other associated code, then runs the real definition as if it had been loaded all along. There are two ways to set up an autoloaded function: by calling `autoload', and by writing a special "magic" comment in the source before the real definition. `autoload' is the low-level primitive for autoloading; any Lisp program can call `autoload' at any time. Magic comments are the most convenient way to make a function autoload, for packages installed along with Emacs. These comments do nothing on their own, but they serve as a guide for the command `update-file-autoloads', which constructs calls to `autoload' and arranges to execute them when Emacs is built. - Function: autoload FUNCTION FILENAME &optional DOCSTRING INTERACTIVE TYPE This function defines the function (or macro) named FUNCTION so as to load automatically from FILENAME. The string FILENAME specifies the file to load to get the real definition of FUNCTION. If FILENAME does not contain either a directory name, or the suffix `.el' or `.elc', then `autoload' insists on adding one of these suffixes, and it will not load from a file whose name is just FILENAME with no added suffix. The argument DOCSTRING is the documentation string for the function. Normally, this should be identical to the documentation string in the function definition itself. Specifying the documentation string in the call to `autoload' makes it possible to look at the documentation without loading the function's real definition. If INTERACTIVE is non-`nil', that says FUNCTION can be called interactively. This lets completion in `M-x' work without loading FUNCTION's real definition. The complete interactive specification is not given here; it's not needed unless the user actually calls FUNCTION, and when that happens, it's time to load the real definition. You can autoload macros and keymaps as well as ordinary functions. Specify TYPE as `macro' if FUNCTION is really a macro. Specify TYPE as `keymap' if FUNCTION is really a keymap. Various parts of Emacs need to know this information without loading the real definition. An autoloaded keymap loads automatically during key lookup when a prefix key's binding is the symbol FUNCTION. Autoloading does not occur for other kinds of access to the keymap. In particular, it does not happen when a Lisp program gets the keymap from the value of a variable and calls `define-key'; not even if the variable name is the same symbol FUNCTION. If FUNCTION already has a non-void function definition that is not an autoload object, `autoload' does nothing and returns `nil'. If the function cell of FUNCTION is void, or is already an autoload object, then it is defined as an autoload object like this: (autoload FILENAME DOCSTRING INTERACTIVE TYPE) For example, (symbol-function 'run-prolog) => (autoload "prolog" 169681 t nil) In this case, `"prolog"' is the name of the file to load, 169681 refers to the documentation string in the `emacs/etc/DOC-VERSION' file (*note Documentation Basics::.), `t' means the function is interactive, and `nil' that it is not a macro or a keymap. The autoloaded file usually contains other definitions and may require or provide one or more features. If the file is not completely loaded (due to an error in the evaluation of its contents), any function definitions or `provide' calls that occurred during the load are undone. This is to ensure that the next attempt to call any function autoloading from this file will try again to load the file. If not for this, then some of the functions in the file might be defined by the aborted load, but fail to work properly for the lack of certain subroutines not loaded successfully because they come later in the file. If the autoloaded file fails to define the desired Lisp function or macro, then an error is signaled with data `"Autoloading failed to define function FUNCTION-NAME"'. A magic autoload comment consists of `;;;###autoload', on a line by itself, just before the real definition of the function in its autoloadable source file. The command `M-x update-file-autoloads' writes a corresponding `autoload' call into `loaddefs.el'. Building Emacs loads `loaddefs.el' and thus calls `autoload'. `M-x update-directory-autoloads' is even more powerful; it updates autoloads for all files in the current directory. The same magic comment can copy any kind of form into `loaddefs.el'. If the form following the magic comment is not a function definition, it is copied verbatim. You can also use a magic comment to execute a form at build time *without* executing it when the file itself is loaded. To do this, write the form *on the same line* as the magic comment. Since it is in a comment, it does nothing when you load the source file; but `M-x update-file-autoloads' copies it to `loaddefs.el', where it is executed while building Emacs. The following example shows how `doctor' is prepared for autoloading with a magic comment: ;;;###autoload (defun doctor () "Switch to *doctor* buffer and start giving psychotherapy." (interactive) (switch-to-buffer "*doctor*") (doctor-mode)) Here's what that produces in `loaddefs.el': (autoload 'doctor "doctor" "\ Switch to *doctor* buffer and start giving psychotherapy." t) The backslash and newline immediately following the double-quote are a convention used only in the preloaded Lisp files such as `loaddefs.el'; they tell `make-docfile' to put the documentation string in the `etc/DOC' file. *Note Building Emacs::. Repeated Loading ================ You can load a given file more than once in an Emacs session. For example, after you have rewritten and reinstalled a function definition by editing it in a buffer, you may wish to return to the original version; you can do this by reloading the file it came from. When you load or reload files, bear in mind that the `load' and `load-library' functions automatically load a byte-compiled file rather than a non-compiled file of similar name. If you rewrite a file that you intend to save and reinstall, you need to byte-compile the new version; otherwise Emacs will load the older, byte-compiled file instead of your newer, non-compiled file! If that happens, the message displayed when loading the file includes, `(compiled; note, source is newer)', to remind you to recompile it. When writing the forms in a Lisp library file, keep in mind that the file might be loaded more than once. For example, think about whether each variable should be reinitialized when you reload the library; `defvar' does not change the value if the variable is already initialized. (*Note Defining Variables::.) The simplest way to add an element to an alist is like this: (setq minor-mode-alist (cons '(leif-mode " Leif") minor-mode-alist)) But this would add multiple elements if the library is reloaded. To avoid the problem, write this: (or (assq 'leif-mode minor-mode-alist) (setq minor-mode-alist (cons '(leif-mode " Leif") minor-mode-alist))) To add an element to a list just once, you can also use `add-to-list' (*note Setting Variables::.). Occasionally you will want to test explicitly whether a library has already been loaded. Here's one way to test, in a library, whether it has been loaded before: (defvar foo-was-loaded nil) (unless foo-was-loaded EXECUTE-FIRST-TIME-ONLY (setq foo-was-loaded t)) If the library uses `provide' to provide a named feature, you can use `featurep' earlier in the file to test whether the `provide' call has been executed before. *Note Named Features::. Features ======== `provide' and `require' are an alternative to `autoload' for loading files automatically. They work in terms of named "features". Autoloading is triggered by calling a specific function, but a feature is loaded the first time another program asks for it by name. A feature name is a symbol that stands for a collection of functions, variables, etc. The file that defines them should "provide" the feature. Another program that uses them may ensure they are defined by "requiring" the feature. This loads the file of definitions if it hasn't been loaded already. To require the presence of a feature, call `require' with the feature name as argument. `require' looks in the global variable `features' to see whether the desired feature has been provided already. If not, it loads the feature from the appropriate file. This file should call `provide' at the top level to add the feature to `features'; if it fails to do so, `require' signals an error. For example, in `emacs/lisp/prolog.el', the definition for `run-prolog' includes the following code: (defun run-prolog () "Run an inferior Prolog process, with I/O via buffer *prolog*." (interactive) (require 'comint) (switch-to-buffer (make-comint "prolog" prolog-program-name)) (inferior-prolog-mode)) The expression `(require 'comint)' loads the file `comint.el' if it has not yet been loaded. This ensures that `make-comint' is defined. Features are normally named after the files that provide them, so that `require' need not be given the file name. The `comint.el' file contains the following top-level expression: (provide 'comint) This adds `comint' to the global `features' list, so that `(require 'comint)' will henceforth know that nothing needs to be done. When `require' is used at top level in a file, it takes effect when you byte-compile that file (*note Byte Compilation::.) as well as when you load it. This is in case the required package contains macros that the byte compiler must know about. Although top-level calls to `require' are evaluated during byte compilation, `provide' calls are not. Therefore, you can ensure that a file of definitions is loaded before it is byte-compiled by including a `provide' followed by a `require' for the same feature, as in the following example. (provide 'my-feature) ; Ignored by byte compiler, ; evaluated by `load'. (require 'my-feature) ; Evaluated by byte compiler. The compiler ignores the `provide', then processes the `require' by loading the file in question. Loading the file does execute the `provide' call, so the subsequent `require' call does nothing when the file is loaded. - Function: provide FEATURE This function announces that FEATURE is now loaded, or being loaded, into the current Emacs session. This means that the facilities associated with FEATURE are or will be available for other Lisp programs. The direct effect of calling `provide' is to add FEATURE to the front of the list `features' if it is not already in the list. The argument FEATURE must be a symbol. `provide' returns FEATURE. features => (bar bish) (provide 'foo) => foo features => (foo bar bish) When a file is loaded to satisfy an autoload, and it stops due to an error in the evaluating its contents, any function definitions or `provide' calls that occurred during the load are undone. *Note Autoload::. - Function: require FEATURE &optional FILENAME This function checks whether FEATURE is present in the current Emacs session (using `(featurep FEATURE)'; see below). The argument FEATURE must be a symbol. If the feature is not present, then `require' loads FILENAME with `load'. If FILENAME is not supplied, then the name of the symbol FEATURE is used as the base file name to load. However, in this case, `require' insists on finding FEATURE with an added suffix; a file whose name is just FEATURE won't be used. If loading the file fails to provide FEATURE, `require' signals an error, `Required feature FEATURE was not provided'. - Function: featurep FEATURE This function returns `t' if FEATURE has been provided in the current Emacs session (i.e., if FEATURE is a member of `features'.) - Variable: features The value of this variable is a list of symbols that are the features loaded in the current Emacs session. Each symbol was put in this list with a call to `provide'. The order of the elements in the `features' list is not significant. Unloading ========= You can discard the functions and variables loaded by a library to reclaim memory for other Lisp objects. To do this, use the function `unload-feature': - Command: unload-feature FEATURE &optional FORCE This command unloads the library that provided feature FEATURE. It undefines all functions, macros, and variables defined in that library with `defun', `defalias', `defsubst', `defmacro', `defconst', `defvar', and `defcustom'. It then restores any autoloads formerly associated with those symbols. (Loading saves these in the `autoload' property of the symbol.) Before restoring the previous definitions, `unload-feature' runs `remove-hook' to remove functions in the library from certain hooks. These hooks include variables whose names end in `hook' or `-hooks', plus those listed in `loadhist-special-hooks'. This is to prevent Emacs from ceasing to function because important hooks refer to functions that are no longer defined. If these measures are not sufficient to prevent malfunction, a library can define an explicit unload hook. If `FEATURE-unload-hook' is defined, it is run as a normal hook before restoring the previous definitions, *instead of* the usual hook-removing actions. The unload hook ought to undo all the global state changes made by the library that might cease to work once the library is unloaded. Ordinarily, `unload-feature' refuses to unload a library on which other loaded libraries depend. (A library A depends on library B if A contains a `require' for B.) If the optional argument FORCE is non-`nil', dependencies are ignored and you can unload any library. The `unload-feature' function is written in Lisp; its actions are based on the variable `load-history'. - Variable: load-history This variable's value is an alist connecting library names with the names of functions and variables they define, the features they provide, and the features they require. Each element is a list and describes one library. The CAR of the list is the name of the library, as a string. The rest of the list is composed of these kinds of objects: * Symbols that were defined by this library. * Lists of the form `(require . FEATURE)' indicating features that were required. * Lists of the form `(provide . FEATURE)' indicating features that were provided. The value of `load-history' may have one element whose CAR is `nil'. This element describes definitions made with `eval-buffer' on a buffer that is not visiting a file. The command `eval-region' updates `load-history', but does so by adding the symbols defined to the element for the file being visited, rather than replacing that element. *Note Eval::. Preloaded libraries don't contribute to `load-history'. - Variable: loadhist-special-hooks This variable holds a list of hooks to be scanned before unloading a library, to remove functions defined in the library. Hooks for Loading ================= You can ask for code to be executed if and when a particular library is loaded, by calling `eval-after-load'. - Function: eval-after-load LIBRARY FORM This function arranges to evaluate FORM at the end of loading the library LIBRARY, if and when LIBRARY is loaded. If LIBRARY is already loaded, it evaluates FORM right away. The library name LIBRARY must exactly match the argument of `load'. To get the proper results when an installed library is found by searching `load-path', you should not include any directory names in LIBRARY. An error in FORM does not undo the load, but does prevent execution of the rest of FORM. In general, well-designed Lisp programs should not use this feature. The clean and modular ways to interact with a Lisp library are (1) examine and set the library's variables (those which are meant for outside use), and (2) call the library's functions. If you wish to do (1), you can do it immediately--there is no need to wait for when the library is loaded. To do (2), you must load the library (preferably with `require'). But it is OK to use `eval-after-load' in your personal customizations if you don't feel they must meet the design standards for programs meant for wider use. - Variable: after-load-alist An alist of expressions to evaluate if and when particular libraries are loaded. Each element looks like this: (FILENAME FORMS...) The function `load' checks `after-load-alist' in order to implement `eval-after-load'. Byte Compilation **************** Emacs Lisp has a "compiler" that translates functions written in Lisp into a special representation called "byte-code" that can be executed more efficiently. The compiler replaces Lisp function definitions with byte-code. When a byte-code function is called, its definition is evaluated by the "byte-code interpreter". Because the byte-compiled code is evaluated by the byte-code interpreter, instead of being executed directly by the machine's hardware (as true compiled code is), byte-code is completely transportable from machine to machine without recompilation. It is not, however, as fast as true compiled code. Compiling a Lisp file with the Emacs byte compiler always reads the file as multibyte text, even if Emacs was started with `--unibyte', unless the file specifies otherwise. This is so that compilation gives results compatible with running the same file without compilation. *Note Loading Non-ASCII::. In general, any version of Emacs can run byte-compiled code produced by recent earlier versions of Emacs, but the reverse is not true. A major incompatible change was introduced in Emacs version 19.29, and files compiled with versions since that one will definitely not run in earlier versions unless you specify a special option. In addition, the modifier bits in keyboard characters were renumbered in Emacs 19.29; as a result, files compiled in versions before 19.29 will not work in subsequent versions if they contain character constants with modifier bits. *Note Compilation Errors::, for how to investigate errors occurring in byte compilation. Performance of Byte-Compiled Code ================================= A byte-compiled function is not as efficient as a primitive function written in C, but runs much faster than the version written in Lisp. Here is an example: (defun silly-loop (n) "Return time before and after N iterations of a loop." (let ((t1 (current-time-string))) (while (> (setq n (1- n)) 0)) (list t1 (current-time-string)))) => silly-loop (silly-loop 100000) => ("Fri Mar 18 17:25:57 1994" "Fri Mar 18 17:26:28 1994") ; 31 seconds (byte-compile 'silly-loop) => [Compiled code not shown] (silly-loop 100000) => ("Fri Mar 18 17:26:52 1994" "Fri Mar 18 17:26:58 1994") ; 6 seconds In this example, the interpreted code required 31 seconds to run, whereas the byte-compiled code required 6 seconds. These results are representative, but actual results will vary greatly. The Compilation Functions ========================= You can byte-compile an individual function or macro definition with the `byte-compile' function. You can compile a whole file with `byte-compile-file', or several files with `byte-recompile-directory' or `batch-byte-compile'. The byte compiler produces error messages and warnings about each file in a buffer called `*Compile-Log*'. These report things in your program that suggest a problem but are not necessarily erroneous. Be careful when writing macro calls in files that you may someday byte-compile. Macro calls are expanded when they are compiled, so the macros must already be defined for proper compilation. For more details, see *Note Compiling Macros::. Normally, compiling a file does not evaluate the file's contents or load the file. But it does execute any `require' calls at top level in the file. One way to ensure that necessary macro definitions are available during compilation is to require the file that defines them (*note Named Features::.). To avoid loading the macro definition files when someone *runs* the compiled program, write `eval-when-compile' around the `require' calls (*note Eval During Compile::.). - Function: byte-compile SYMBOL This function byte-compiles the function definition of SYMBOL, replacing the previous definition with the compiled one. The function definition of SYMBOL must be the actual code for the function; i.e., the compiler does not follow indirection to another symbol. `byte-compile' returns the new, compiled definition of SYMBOL. If SYMBOL's definition is a byte-code function object, `byte-compile' does nothing and returns `nil'. Lisp records only one function definition for any symbol, and if that is already compiled, non-compiled code is not available anywhere. So there is no way to "compile the same definition again." (defun factorial (integer) "Compute factorial of INTEGER." (if (= 1 integer) 1 (* integer (factorial (1- integer))))) => factorial (byte-compile 'factorial) => #[(integer) "^H\301U\203^H^@\301\207\302^H\303^HS!\"\207" [integer 1 * factorial] 4 "Compute factorial of INTEGER."] The result is a byte-code function object. The string it contains is the actual byte-code; each character in it is an instruction or an operand of an instruction. The vector contains all the constants, variable names and function names used by the function, except for certain primitives that are coded as special instructions. - Command: compile-defun This command reads the defun containing point, compiles it, and evaluates the result. If you use this on a defun that is actually a function definition, the effect is to install a compiled version of that function. - Command: byte-compile-file FILENAME This function compiles a file of Lisp code named FILENAME into a file of byte-code. The output file's name is made by changing the `.el' suffix into `.elc'; if FILENAME does not end in `.el', it adds `.elc' to the end of FILENAME. Compilation works by reading the input file one form at a time. If it is a definition of a function or macro, the compiled function or macro definition is written out. Other forms are batched together, then each batch is compiled, and written so that its compiled code will be executed when the file is read. All comments are discarded when the input file is read. This command returns `t'. When called interactively, it prompts for the file name. % ls -l push* -rw-r--r-- 1 lewis 791 Oct 5 20:31 push.el (byte-compile-file "~/emacs/push.el") => t % ls -l push* -rw-r--r-- 1 lewis 791 Oct 5 20:31 push.el -rw-rw-rw- 1 lewis 638 Oct 8 20:25 push.elc - Command: byte-recompile-directory DIRECTORY FLAG This function recompiles every `.el' file in DIRECTORY that needs recompilation. A file needs recompilation if a `.elc' file exists but is older than the `.el' file. When a `.el' file has no corresponding `.elc' file, FLAG says what to do. If it is `nil', these files are ignored. If it is non-`nil', the user is asked whether to compile each such file. The returned value of this command is unpredictable. - Function: batch-byte-compile This function runs `byte-compile-file' on files specified on the command line. This function must be used only in a batch execution of Emacs, as it kills Emacs on completion. An error in one file does not prevent processing of subsequent files, but no output file will be generated for it, and the Emacs process will terminate with a nonzero status code. % emacs -batch -f batch-byte-compile *.el - Function: byte-code CODE-STRING DATA-VECTOR MAX-STACK This function actually interprets byte-code. A byte-compiled function is actually defined with a body that calls `byte-code'. Don't call this function yourself--only the byte compiler knows how to generate valid calls to this function. In Emacs version 18, byte-code was always executed by way of a call to the function `byte-code'. Nowadays, byte-code is usually executed as part of a byte-code function object, and only rarely through an explicit call to `byte-code'. Documentation Strings and Compilation ===================================== Functions and variables loaded from a byte-compiled file access their documentation strings dynamically from the file whenever needed. This saves space within Emacs, and makes loading faster because the documentation strings themselves need not be processed while loading the file. Actual access to the documentation strings becomes slower as a result, but this normally is not enough to bother users. Dynamic access to documentation strings does have drawbacks: * If you delete or move the compiled file after loading it, Emacs can no longer access the documentation strings for the functions and variables in the file. * If you alter the compiled file (such as by compiling a new version), then further access to documentation strings in this file will give nonsense results. If your site installs Emacs following the usual procedures, these problems will never normally occur. Installing a new version uses a new directory with a different name; as long as the old version remains installed, its files will remain unmodified in the places where they are expected to be. However, if you have built Emacs yourself and use it from the directory where you built it, you will experience this problem occasionally if you edit and recompile Lisp files. When it happens, you can cure the problem by reloading the file after recompiling it. Byte-compiled files made with recent versions of Emacs (since 19.29) will not load into older versions because the older versions don't support this feature. You can turn off this feature at compile time by setting `byte-compile-dynamic-docstrings' to `nil'; then you can compile files that will load into older Emacs versions. You can do this globally, or for one source file by specifying a file-local binding for the variable. One way to do that is by adding this string to the file's first line: -*-byte-compile-dynamic-docstrings: nil;-*- - Variable: byte-compile-dynamic-docstrings If this is non-`nil', the byte compiler generates compiled files that are set up for dynamic loading of documentation strings. The dynamic documentation string feature writes compiled files that use a special Lisp reader construct, `#@COUNT'. This construct skips the next COUNT characters. It also uses the `#$' construct, which stands for "the name of this file, as a string." It is usually best not to use these constructs in Lisp source files, since they are not designed to be clear to humans reading the file. Dynamic Loading of Individual Functions ======================================= When you compile a file, you can optionally enable the "dynamic function loading" feature (also known as "lazy loading"). With dynamic function loading, loading the file doesn't fully read the function definitions in the file. Instead, each function definition contains a place-holder which refers to the file. The first time each function is called, it reads the full definition from the file, to replace the place-holder. The advantage of dynamic function loading is that loading the file becomes much faster. This is a good thing for a file which contains many separate user-callable functions, if using one of them does not imply you will probably also use the rest. A specialized mode which provides many keyboard commands often has that usage pattern: a user may invoke the mode, but use only a few of the commands it provides. The dynamic loading feature has certain disadvantages: * If you delete or move the compiled file after loading it, Emacs can no longer load the remaining function definitions not already loaded. * If you alter the compiled file (such as by compiling a new version), then trying to load any function not already loaded will yield nonsense results. These problems will never happen in normal circumstances with installed Emacs files. But they are quite likely to happen with Lisp files that you are changing. The easiest way to prevent these problems is to reload the new compiled file immediately after each recompilation. The byte compiler uses the dynamic function loading feature if the variable `byte-compile-dynamic' is non-`nil' at compilation time. Do not set this variable globally, since dynamic loading is desirable only for certain files. Instead, enable the feature for specific source files with file-local variable bindings. For example, you could do it by writing this text in the source file's first line: -*-byte-compile-dynamic: t;-*- - Variable: byte-compile-dynamic If this is non-`nil', the byte compiler generates compiled files that are set up for dynamic function loading. - Function: fetch-bytecode FUNCTION This immediately finishes loading the definition of FUNCTION from its byte-compiled file, if it is not fully loaded already. The argument FUNCTION may be a byte-code function object or a function name. Evaluation During Compilation ============================= These features permit you to write code to be evaluated during compilation of a program. - Special Form: eval-and-compile BODY This form marks BODY to be evaluated both when you compile the containing code and when you run it (whether compiled or not). You can get a similar result by putting BODY in a separate file and referring to that file with `require'. That method is preferable when BODY is large. - Special Form: eval-when-compile BODY This form marks BODY to be evaluated at compile time but not when the compiled program is loaded. The result of evaluation by the compiler becomes a constant which appears in the compiled program. If you load the source file, rather than compiling it, BODY is evaluated normally. *Common Lisp Note:* At top level, this is analogous to the Common Lisp idiom `(eval-when (compile eval) ...)'. Elsewhere, the Common Lisp `#.' reader macro (but not when interpreting) is closer to what `eval-when-compile' does. Byte-Code Function Objects ========================== Byte-compiled functions have a special data type: they are "byte-code function objects". Internally, a byte-code function object is much like a vector; however, the evaluator handles this data type specially when it appears as a function to be called. The printed representation for a byte-code function object is like that for a vector, with an additional `#' before the opening `['. A byte-code function object must have at least four elements; there is no maximum number, but only the first six elements have any normal use. They are: ARGLIST The list of argument symbols. BYTE-CODE The string containing the byte-code instructions. CONSTANTS The vector of Lisp objects referenced by the byte code. These include symbols used as function names and variable names. STACKSIZE The maximum stack size this function needs. DOCSTRING The documentation string (if any); otherwise, `nil'. The value may be a number or a list, in case the documentation string is stored in a file. Use the function `documentation' to get the real documentation string (*note Accessing Documentation::.). INTERACTIVE The interactive spec (if any). This can be a string or a Lisp expression. It is `nil' for a function that isn't interactive. Here's an example of a byte-code function object, in printed representation. It is the definition of the command `backward-sexp'. #[(&optional arg) "^H\204^F^@\301^P\302^H[!\207" [arg 1 forward-sexp] 2 254435 "p"] The primitive way to create a byte-code object is with `make-byte-code': - Function: make-byte-code &rest ELEMENTS This function constructs and returns a byte-code function object with ELEMENTS as its elements. You should not try to come up with the elements for a byte-code function yourself, because if they are inconsistent, Emacs may crash when you call the function. Always leave it to the byte compiler to create these objects; it makes the elements consistent (we hope). You can access the elements of a byte-code object using `aref'; you can also use `vconcat' to create a vector with the same elements. Disassembled Byte-Code ====================== People do not write byte-code; that job is left to the byte compiler. But we provide a disassembler to satisfy a cat-like curiosity. The disassembler converts the byte-compiled code into humanly readable form. The byte-code interpreter is implemented as a simple stack machine. It pushes values onto a stack of its own, then pops them off to use them in calculations whose results are themselves pushed back on the stack. When a byte-code function returns, it pops a value off the stack and returns it as the value of the function. In addition to the stack, byte-code functions can use, bind, and set ordinary Lisp variables, by transferring values between variables and the stack. - Command: disassemble OBJECT &optional STREAM This function prints the disassembled code for OBJECT. If STREAM is supplied, then output goes there. Otherwise, the disassembled code is printed to the stream `standard-output'. The argument OBJECT can be a function name or a lambda expression. As a special exception, if this function is used interactively, it outputs to a buffer named `*Disassemble*'. Here are two examples of using the `disassemble' function. We have added explanatory comments to help you relate the byte-code to the Lisp source; these do not appear in the output of `disassemble'. These examples show unoptimized byte-code. Nowadays byte-code is usually optimized, but we did not want to rewrite these examples, since they still serve their purpose. (defun factorial (integer) "Compute factorial of an integer." (if (= 1 integer) 1 (* integer (factorial (1- integer))))) => factorial (factorial 4) => 24 (disassemble 'factorial) -| byte-code for factorial: doc: Compute factorial of an integer. args: (integer) 0 constant 1 ; Push 1 onto stack. 1 varref integer ; Get value of `integer' ; from the environment ; and push the value ; onto the stack. 2 eqlsign ; Pop top two values off stack, ; compare them, ; and push result onto stack. 3 goto-if-nil 10 ; Pop and test top of stack; ; if `nil', go to 10, ; else continue. 6 constant 1 ; Push 1 onto top of stack. 7 goto 17 ; Go to 17 (in this case, 1 will be ; returned by the function). 10 constant * ; Push symbol `*' onto stack. 11 varref integer ; Push value of `integer' onto stack. 12 constant factorial ; Push `factorial' onto stack. 13 varref integer ; Push value of `integer' onto stack. 14 sub1 ; Pop `integer', decrement value, ; push new value onto stack. ; Stack now contains: ; - decremented value of `integer' ; - `factorial' ; - value of `integer' ; - `*' 15 call 1 ; Call function `factorial' using ; the first (i.e., the top) element ; of the stack as the argument; ; push returned value onto stack. ; Stack now contains: ; - result of recursive ; call to `factorial' ; - value of `integer' ; - `*' 16 call 2 ; Using the first two ; (i.e., the top two) ; elements of the stack ; as arguments, ; call the function `*', ; pushing the result onto the stack. 17 return ; Return the top element ; of the stack. => nil The `silly-loop' function is somewhat more complex: (defun silly-loop (n) "Return time before and after N iterations of a loop." (let ((t1 (current-time-string))) (while (> (setq n (1- n)) 0)) (list t1 (current-time-string)))) => silly-loop (disassemble 'silly-loop) -| byte-code for silly-loop: doc: Return time before and after N iterations of a loop. args: (n) 0 constant current-time-string ; Push ; `current-time-string' ; onto top of stack. 1 call 0 ; Call `current-time-string' ; with no argument, ; pushing result onto stack. 2 varbind t1 ; Pop stack and bind `t1' ; to popped value. 3 varref n ; Get value of `n' from ; the environment and push ; the value onto the stack. 4 sub1 ; Subtract 1 from top of stack. 5 dup ; Duplicate the top of the stack; ; i.e., copy the top of ; the stack and push the ; copy onto the stack. 6 varset n ; Pop the top of the stack, ; and bind `n' to the value. ; In effect, the sequence `dup varset' ; copies the top of the stack ; into the value of `n' ; without popping it. 7 constant 0 ; Push 0 onto stack. 8 gtr ; Pop top two values off stack, ; test if N is greater than 0 ; and push result onto stack. 9 goto-if-nil-else-pop 17 ; Goto 17 if `n' <= 0 ; (this exits the while loop). ; else pop top of stack ; and continue 12 constant nil ; Push `nil' onto stack ; (this is the body of the loop). 13 discard ; Discard result of the body ; of the loop (a while loop ; is always evaluated for ; its side effects). 14 goto 3 ; Jump back to beginning ; of while loop. 17 discard ; Discard result of while loop ; by popping top of stack. ; This result is the value `nil' that ; was not popped by the goto at 9. 18 varref t1 ; Push value of `t1' onto stack. 19 constant current-time-string ; Push ; `current-time-string' ; onto top of stack. 20 call 0 ; Call `current-time-string' again. 21 list2 ; Pop top two elements off stack, ; create a list of them, ; and push list onto stack. 22 unbind 1 ; Unbind `t1' in local environment. 23 return ; Return value of the top of stack. => nil Advising Emacs Lisp Functions ***************************** The "advice" feature lets you add to the existing definition of a function, by "advising the function". This is a clean method for a library to customize functions defined by other parts of Emacs--cleaner than redefining the whole function. Each function can have multiple "pieces of advice", separately defined. Each defined piece of advice can be enabled or disabled explicitly. The enabled pieces of advice for any given function actually take effect when you "activate" advice for that function, or when that function is subsequently defined or redefined. *Usage Note:* Advice is useful for altering the behavior of existing calls to an existing function. If you want the new behavior for new calls, or for key bindings, it is cleaner to define a new function (or a new command) which uses the existing function. A Simple Advice Example ======================= The command `next-line' moves point down vertically one or more lines; it is the standard binding of `C-n'. When used on the last line of the buffer, this command inserts a newline to create a line to move to (if `next-line-add-newlines' is non-`nil'). Suppose you wanted to add a similar feature to `previous-line', which would insert a new line at the beginning of the buffer for the command to move to. How could you do this? You could do it by redefining the whole function, but that is not modular. The advice feature provides a cleaner alternative: you can effectively add your code to the existing function definition, without actually changing or even seeing that definition. Here is how to do this: (defadvice previous-line (before next-line-at-end (arg)) "Insert an empty line when moving up from the top line." (if (and next-line-add-newlines (= arg 1) (save-excursion (beginning-of-line) (bobp))) (progn (beginning-of-line) (newline)))) This expression defines a "piece of advice" for the function `previous-line'. This piece of advice is named `next-line-at-end', and the symbol `before' says that it is "before-advice" which should run before the regular definition of `previous-line'. `(arg)' specifies how the advice code can refer to the function's arguments. When this piece of advice runs, it creates an additional line, in the situation where that is appropriate, but does not move point to that line. This is the correct way to write the advice, because the normal definition will run afterward and will move back to the newly inserted line. Defining the advice doesn't immediately change the function `previous-line'. That happens when you "activate" the advice, like this: (ad-activate 'previous-line) This is what actually begins to use the advice that has been defined so far for the function `previous-line'. Henceforth, whenever that function is run, whether invoked by the user with `C-p' or `M-x', or called from Lisp, it runs the advice first, and its regular definition second. This example illustrates before-advice, which is one "class" of advice: it runs before the function's base definition. There are two other advice classes: "after-advice", which runs after the base definition, and "around-advice", which lets you specify an expression to wrap around the invocation of the base definition. Defining Advice =============== To define a piece of advice, use the macro `defadvice'. A call to `defadvice' has the following syntax, which is based on the syntax of `defun' and `defmacro', but adds more: (defadvice FUNCTION (CLASS NAME [POSITION] [ARGLIST] FLAGS...) [DOCUMENTATION-STRING] [INTERACTIVE-FORM] BODY-FORMS...) Here, FUNCTION is the name of the function (or macro or special form) to be advised. From now on, we will write just "function" when describing the entity being advised, but this always includes macros and special forms. CLASS specifies the "class" of the advice--one of `before', `after', or `around'. Before-advice runs before the function itself; after-advice runs after the function itself; around-advice is wrapped around the execution of the function itself. After-advice and around-advice can override the return value by setting `ad-return-value'. - Variable: ad-return-value While advice is executing, after the function's original definition has been executed, this variable holds its return value, which will ultimately be returned to the caller after finishing all the advice. After-advice and around-advice can arrange to return some other value by storing it in this variable. The argument NAME is the name of the advice, a non-`nil' symbol. The advice name uniquely identifies one piece of advice, within all the pieces of advice in a particular class for a particular FUNCTION. The name allows you to refer to the piece of advice--to redefine it, or to enable or disable it. In place of the argument list in an ordinary definition, an advice definition calls for several different pieces of information. The optional POSITION specifies where, in the current list of advice of the specified CLASS, this new advice should be placed. It should be either `first', `last' or a number that specifies a zero-based position (`first' is equivalent to 0). If no position is specified, the default is `first'. Position values outside the range of existing positions in this class are mapped to the beginning or the end of the range, whichever is closer. The POSITION value is ignored when redefining an existing piece of advice. The optional ARGLIST can be used to define the argument list for the sake of advice. This becomes the argument list of the combined definition that is generated in order to run the advice (*note Combined Definition::.). Therefore, the advice expressions can use the argument variables in this list to access argument values. This argument list must be compatible with the argument list of the original function, so that it can handle the ways the function is actually called. If more than one piece of advice specifies an argument list, then the first one (the one with the smallest position) found in the list of all classes of advice is used. The remaining elements, FLAGS, are symbols that specify further information about how to use this piece of advice. Here are the valid symbols and their meanings: `activate' Activate the advice for FUNCTION now. Changes in a function's advice always take effect the next time you activate advice for the function; this flag says to do so, for FUNCTION, immediately after defining this piece of advice. This flag has no effect if FUNCTION itself is not defined yet (a situation known as "forward advice"), because it is impossible to activate an undefined function's advice. However, defining FUNCTION will automatically activate its advice. `protect' Protect this piece of advice against non-local exits and errors in preceding code and advice. Protecting advice places it as a cleanup in an `unwind-protect' form, so that it will execute even if the previous code gets an error or uses `throw'. *Note Cleanups::. `compile' Compile the combined definition that is used to run the advice. This flag is ignored unless `activate' is also specified. *Note Combined Definition::. `disable' Initially disable this piece of advice, so that it will not be used unless subsequently explicitly enabled. *Note Enabling Advice::. `preactivate' Activate advice for FUNCTION when this `defadvice' is compiled or macroexpanded. This generates a compiled advised definition according to the current advice state, which will be used during activation if appropriate. This is useful only if this `defadvice' is byte-compiled. The optional DOCUMENTATION-STRING serves to document this piece of advice. When advice is active for FUNCTION, the documentation for FUNCTION (as returned by `documentation') combines the documentation strings of all the advice for FUNCTION with the documentation string of its original function definition. The optional INTERACTIVE-FORM form can be supplied to change the interactive behavior of the original function. If more than one piece of advice has an INTERACTIVE-FORM, then the first one (the one with the smallest position) found among all the advice takes precedence. The possibly empty list of BODY-FORMS specifies the body of the advice. The body of an advice can access or change the arguments, the return value, the binding environment, and perform any other kind of side effect. *Warning:* When you advise a macro, keep in mind that macros are expanded when a program is compiled, not when a compiled program is run. All subroutines used by the advice need to be available when the byte compiler expands the macro. Around-Advice ============= Around-advice lets you "wrap" a Lisp expression "around" the original function definition. You specify where the original function definition should go by means of the special symbol `ad-do-it'. Where this symbol occurs inside the around-advice body, it is replaced with a `progn' containing the forms of the surrounded code. Here is an example: (defadvice foo (around foo-around) "Ignore case in `foo'." (let ((case-fold-search t)) ad-do-it)) Its effect is to make sure that case is ignored in searches when the original definition of `foo' is run. - Variable: ad-do-it This is not really a variable, but it is somewhat used like one in around-advice. It specifies the place to run the function's original definition and other "earlier" around-advice. If the around-advice does not use `ad-do-it', then it does not run the original function definition. This provides a way to override the original definition completely. (It also overrides lower-positioned pieces of around-advice). Computed Advice =============== The macro `defadvice' resembles `defun' in that the code for the advice, and all other information about it, are explicitly stated in the source code. You can also create advice whose details are computed, using the function `ad-add-advice'. - Function: ad-add-advice FUNCTION ADVICE CLASS POSITION Calling `ad-add-advice' adds ADVICE as a piece of advice to FUNCTION in class CLASS. The argument ADVICE has this form: (NAME PROTECTED ENABLED DEFINITION) Here PROTECTED and ENABLED are flags, and DEFINITION is the expression that says what the advice should do. If ENABLED is `nil', this piece of advice is initially disabled (*note Enabling Advice::.). If FUNCTION already has one or more pieces of advice in the specified CLASS, then POSITION specifies where in the list to put the new piece of advice. The value of POSITION can either be `first', `last', or a number (counting from 0 at the beginning of the list). Numbers outside the range are mapped to the closest extreme position. If FUNCTION already has a piece of ADVICE with the same name, then the position argument is ignored and the old advice is replaced with the new one. Activation of Advice ==================== By default, advice does not take effect when you define it--only when you "activate" advice for the function that was advised. You can request the activation of advice for a function when you define the advice, by specifying the `activate' flag in the `defadvice'. But normally you activate the advice for a function by calling the function `ad-activate' or one of the other activation commands listed below. Separating the activation of advice from the act of defining it permits you to add several pieces of advice to one function efficiently, without redefining the function over and over as each advice is added. More importantly, it permits defining advice for a function before that function is actually defined. When a function's advice is first activated, the function's original definition is saved, and all enabled pieces of advice for that function are combined with the original definition to make a new definition. (Pieces of advice that are currently disabled are not used; see *Note Enabling Advice::.) This definition is installed, and optionally byte-compiled as well, depending on conditions described below. In all of the commands to activate advice, if COMPILE is `t', the command also compiles the combined definition which implements the advice. - Command: ad-activate FUNCTION &optional COMPILE This command activates the advice for FUNCTION. To activate advice for a function whose advice is already active is not a no-op. It is a useful operation which puts into effect any changes in that function's advice since the previous activation of advice for that function. - Command: ad-deactivate FUNCTION This command deactivates the advice for FUNCTION. - Command: ad-activate-all &optional COMPILE This command activates the advice for all functions. - Command: ad-deactivate-all This command deactivates the advice for all functions. - Command: ad-activate-regexp REGEXP &optional COMPILE This command activates all pieces of advice whose names match REGEXP. More precisely, it activates all advice for any function which has at least one piece of advice that matches REGEXP. - Command: ad-deactivate-regexp REGEXP This command deactivates all pieces of advice whose names match REGEXP. More precisely, it deactivates all advice for any function which has at least one piece of advice that matches REGEXP. - Command: ad-update-regexp REGEXP &optional COMPILE This command activates pieces of advice whose names match REGEXP, but only those for functions whose advice is already activated. Reactivating a function's advice is useful for putting into effect all the changes that have been made in its advice (including enabling and disabling specific pieces of advice; *note Enabling Advice::.) since the last time it was activated. - Command: ad-start-advice Turn on automatic advice activation when a function is defined or redefined. If you turn on this mode, then advice really does take effect immediately when defined. - Command: ad-stop-advice Turn off automatic advice activation when a function is defined or redefined. - User Option: ad-default-compilation-action This variable controls whether to compile the combined definition that results from activating advice for a function. If the advised definition was constructed during "preactivation" (*note Preactivation::.), then that definition must already be compiled, because it was constructed during byte-compilation of the file that contained the `defadvice' with the `preactivate' flag. Enabling and Disabling Advice ============================= Each piece of advice has a flag that says whether it is enabled or not. By enabling or disabling a piece of advice, you can turn it on and off without having to undefine and redefine it. For example, here is how to disable a particular piece of advice named `my-advice' for the function `foo': (ad-disable-advice 'foo 'before 'my-advice) This function by itself only changes the enable flag for a piece of advice. To make the change take effect in the advised definition, you must activate the advice for `foo' again: (ad-activate 'foo) - Command: ad-disable-advice FUNCTION CLASS NAME This command disables the piece of advice named NAME in class CLASS on FUNCTION. - Command: ad-enable-advice FUNCTION CLASS NAME This command enables the piece of advice named NAME in class CLASS on FUNCTION. You can also disable many pieces of advice at once, for various functions, using a regular expression. As always, the changes take real effect only when you next reactivate advice for the functions in question. - Command: ad-disable-regexp REGEXP This command disables all pieces of advice whose names match REGEXP, in all classes, on all functions. - Command: ad-enable-regexp REGEXP This command enables all pieces of advice whose names match REGEXP, in all classes, on all functions. Preactivation ============= Constructing a combined definition to execute advice is moderately expensive. When a library advises many functions, this can make loading the library slow. In that case, you can use "preactivation" to construct suitable combined definitions in advance. To use preactivation, specify the `preactivate' flag when you define the advice with `defadvice'. This `defadvice' call creates a combined definition which embodies this piece of advice (whether enabled or not) plus any other currently enabled advice for the same function, and the function's own definition. If the `defadvice' is compiled, that compiles the combined definition also. When the function's advice is subsequently activated, if the enabled advice for the function matches what was used to make this combined definition, then the existing combined definition is used, thus avoiding the need to construct one. Thus, preactivation never causes wrong results--but it may fail to do any good, if the enabled advice at the time of activation doesn't match what was used for preactivation. Here are some symptoms that can indicate that a preactivation did not work properly, because of a mismatch. * Activation of the advised function takes longer than usual. * The byte-compiler gets loaded while an advised function gets activated. * `byte-compile' is included in the value of `features' even though you did not ever explicitly use the byte-compiler. Compiled preactivated advice works properly even if the function itself is not defined until later; however, the function needs to be defined when you *compile* the preactivated advice. There is no elegant way to find out why preactivated advice is not being used. What you can do is to trace the function `ad-cache-id-verification-code' (with the function `trace-function-background') before the advised function's advice is activated. After activation, check the value returned by `ad-cache-id-verification-code' for that function: `verified' means that the preactivated advice was used, while other values give some information about why they were considered inappropriate. *Warning:* There is one known case that can make preactivation fail, in that a preconstructed combined definition is used even though it fails to match the current state of advice. This can happen when two packages define different pieces of advice with the same name, in the same class, for the same function. But you should avoid that anyway. Argument Access in Advice ========================= The simplest way to access the arguments of an advised function in the body of a piece of advice is to use the same names that the function definition uses. To do this, you need to know the names of the argument variables of the original function. While this simple method is sufficient in many cases, it has a disadvantage: it is not robust, because it hard-codes the argument names into the advice. If the definition of the original function changes, the advice might break. Another method is to specify an argument list in the advice itself. This avoids the need to know the original function definition's argument names, but it has a limitation: all the advice on any particular function must use the same argument list, because the argument list actually used for all the advice comes from the first piece of advice for that function. A more robust method is to use macros that are translated into the proper access forms at activation time, i.e., when constructing the advised definition. Access macros access actual arguments by position regardless of how these actual arguments get distributed onto the argument variables of a function. This is robust because in Emacs Lisp the meaning of an argument is strictly determined by its position in the argument list. - Macro: ad-get-arg POSITION This returns the actual argument that was supplied at POSITION. - Macro: ad-get-args POSITION This returns the list of actual arguments supplied starting at POSITION. - Macro: ad-set-arg POSITION VALUE This sets the value of the actual argument at POSITION to VALUE - Macro: ad-set-args POSITION VALUE-LIST This sets the list of actual arguments starting at POSITION to VALUE-LIST. Now an example. Suppose the function `foo' is defined as (defun foo (x y &optional z &rest r) ...) and is then called with (foo 0 1 2 3 4 5 6) which means that X is 0, Y is 1, Z is 2 and R is `(3 4 5 6)' within the body of `foo'. Here is what `ad-get-arg' and `ad-get-args' return in this case: (ad-get-arg 0) => 0 (ad-get-arg 1) => 1 (ad-get-arg 2) => 2 (ad-get-arg 3) => 3 (ad-get-args 2) => (2 3 4 5 6) (ad-get-args 4) => (4 5 6) Setting arguments also makes sense in this example: (ad-set-arg 5 "five") has the effect of changing the sixth argument to `"five"'. If this happens in advice executed before the body of `foo' is run, then R will be `(3 4 "five" 6)' within that body. Here is an example of setting a tail of the argument list: (ad-set-args 0 '(5 4 3 2 1 0)) If this happens in advice executed before the body of `foo' is run, then within that body, X will be 5, Y will be 4, Z will be 3, and R will be `(2 1 0)' inside the body of `foo'. These argument constructs are not really implemented as Lisp macros. Instead they are implemented specially by the advice mechanism. Definition of Subr Argument Lists ================================= When the advice facility constructs the combined definition, it needs to know the argument list of the original function. This is not always possible for primitive functions. When advice cannot determine the argument list, it uses `(&rest ad-subr-args)', which always works but is inefficient because it constructs a list of the argument values. You can use `ad-define-subr-args' to declare the proper argument names for a primitive function: - Function: ad-define-subr-args FUNCTION ARGLIST This function specifies that ARGLIST should be used as the argument list for function FUNCTION. For example, (ad-define-subr-args 'fset '(sym newdef)) specifies the argument list for the function `fset'. The Combined Definition ======================= Suppose that a function has N pieces of before-advice, M pieces of around-advice and K pieces of after-advice. Assuming no piece of advice is protected, the combined definition produced to implement the advice for a function looks like this: (lambda ARGLIST [ [ADVISED-DOCSTRING] [(interactive ...)] ] (let (ad-return-value) before-0-body-form... .... before-N-1-body-form... around-0-body-form... around-1-body-form... .... around-M-1-body-form... (setq ad-return-value apply original definition to ARGLIST) other-around-M-1-body-form... .... other-around-1-body-form... other-around-0-body-form... after-0-body-form... .... after-K-1-body-form... ad-return-value)) Macros are redefined as macros, which means adding `macro' to the beginning of the combined definition. The interactive form is present if the original function or some piece of advice specifies one. When an interactive primitive function is advised, a special method is used: to call the primitive with `call-interactively' so that it will read its own arguments. In this case, the advice cannot access the arguments. The body forms of the various advice in each class are assembled according to their specified order. The forms of around-advice L are included in one of the forms of around-advice L - 1. The innermost part of the around advice onion is apply original definition to ARGLIST whose form depends on the type of the original function. The variable `ad-return-value' is set to whatever this returns. The variable is visible to all pieces of advice, which can access and modify it before it is actually returned from the advised function. The semantic structure of advised functions that contain protected pieces of advice is the same. The only difference is that `unwind-protect' forms ensure that the protected advice gets executed even if some previous piece of advice had an error or a non-local exit. If any around-advice is protected, then the whole around-advice onion is protected as a result. Debugging Lisp Programs *********************** There are three ways to investigate a problem in an Emacs Lisp program, depending on what you are doing with the program when the problem appears. * If the problem occurs when you run the program, you can use a Lisp debugger to investigate what is happening during execution. In addition to the ordinary debugger, Emacs comes with a source level debugger, Edebug. This chapter describes both of them. * If the problem is syntactic, so that Lisp cannot even read the program, you can use the Emacs facilities for editing Lisp to localize it. * If the problem occurs when trying to compile the program with the byte compiler, you need to know how to examine the compiler's input buffer. Another useful debugging tool is the dribble file. When a dribble file is open, Emacs copies all keyboard input characters to that file. Afterward, you can examine the file to find out what input was used. *Note Terminal Input::. For debugging problems in terminal descriptions, the `open-termscript' function can be useful. *Note Terminal Output::. The Lisp Debugger ================= The ordinary "Lisp debugger" provides the ability to suspend evaluation of a form. While evaluation is suspended (a state that is commonly known as a "break"), you may examine the run time stack, examine the values of local or global variables, or change those values. Since a break is a recursive edit, all the usual editing facilities of Emacs are available; you can even run programs that will enter the debugger recursively. *Note Recursive Editing::. Entering the Debugger on an Error --------------------------------- The most important time to enter the debugger is when a Lisp error happens. This allows you to investigate the immediate causes of the error. However, entry to the debugger is not a normal consequence of an error. Many commands frequently cause Lisp errors when invoked inappropriately (such as `C-f' at the end of the buffer), and during ordinary editing it would be very inconvenient to enter the debugger each time this happens. So if you want errors to enter the debugger, set the variable `debug-on-error' to non-`nil'. (The command `toggle-debug-on-error' provides an easy way to do this.) - User Option: debug-on-error This variable determines whether the debugger is called when an error is signaled and not handled. If `debug-on-error' is `t', all kinds of errors call the debugger (except those listed in `debug-ignored-errors'). If it is `nil', none call the debugger. The value can also be a list of error conditions that should call the debugger. For example, if you set it to the list `(void-variable)', then only errors about a variable that has no value invoke the debugger. When this variable is non-`nil', Emacs does not create an error handler around process filter functions and sentinels. Therefore, errors in these functions also invoke the debugger. *Note Processes::. - User Option: debug-ignored-errors This variable specifies certain kinds of errors that should not enter the debugger. Its value is a list of error condition symbols and/or regular expressions. If the error has any of those condition symbols, or if the error message matches any of the regular expressions, then that error does not enter the debugger, regardless of the value of `debug-on-error'. The normal value of this variable lists several errors that happen often during editing but rarely result from bugs in Lisp programs. However, "rarely" is not "never"; if your program fails with an error that matches this list, you will need to change this list in order to debug the error. The easiest way is usually to set `debug-ignored-errors' to `nil'. - User Option: debug-on-signal Normally, errors that are caught by `condition-case' never run the debugger, even if `debug-on-error' is non-`nil'. In other words, `condition-case' gets a chance to handle the error before the debugger gets a chance. If you set `debug-on-signal' to a non-`nil' value, then the debugger gets the first chance at every error; an error will invoke the debugger regardless of any `condition-case', if it fits the criteria specified by the values of `debug-on-error' and `debug-ignored-errors'. *Warning:* This variable is strong medicine! Various parts of Emacs handle errors in the normal course of affairs, and you may not even realize that errors happen there. If you set `debug-on-signal' to a non-`nil' value, those errors will enter the debugger. *Warning:* `debug-on-signal' has no effect when `debug-on-error' is `nil'. To debug an error that happens during loading of the `.emacs' file, use the option `--debug-init', which binds `debug-on-error' to `t' while loading `.emacs', and bypasses the `condition-case' which normally catches errors in the init file. If your `.emacs' file sets `debug-on-error', the effect may not last past the end of loading `.emacs'. (This is an undesirable byproduct of the code that implements the `--debug-init' command line option.) The best way to make `.emacs' set `debug-on-error' permanently is with `after-init-hook', like this: (add-hook 'after-init-hook '(lambda () (setq debug-on-error t))) Debugging Infinite Loops ------------------------ When a program loops infinitely and fails to return, your first problem is to stop the loop. On most operating systems, you can do this with `C-g', which causes quit. Ordinary quitting gives no information about why the program was looping. To get more information, you can set the variable `debug-on-quit' to non-`nil'. Quitting with `C-g' is not considered an error, and `debug-on-error' has no effect on the handling of `C-g'. Likewise, `debug-on-quit' has no effect on errors. Once you have the debugger running in the middle of the infinite loop, you can proceed from the debugger using the stepping commands. If you step through the entire loop, you will probably get enough information to solve the problem. - User Option: debug-on-quit This variable determines whether the debugger is called when `quit' is signaled and not handled. If `debug-on-quit' is non-`nil', then the debugger is called whenever you quit (that is, type `C-g'). If `debug-on-quit' is `nil', then the debugger is not called when you quit. *Note Quitting::. Entering the Debugger on a Function Call ---------------------------------------- To investigate a problem that happens in the middle of a program, one useful technique is to enter the debugger whenever a certain function is called. You can do this to the function in which the problem occurs, and then step through the function, or you can do this to a function called shortly before the problem, step quickly over the call to that function, and then step through its caller. - Command: debug-on-entry FUNCTION-NAME This function requests FUNCTION-NAME to invoke the debugger each time it is called. It works by inserting the form `(debug 'debug)' into the function definition as the first form. Any function defined as Lisp code may be set to break on entry, regardless of whether it is interpreted code or compiled code. If the function is a command, it will enter the debugger when called from Lisp and when called interactively (after the reading of the arguments). You can't debug primitive functions (i.e., those written in C) this way. When `debug-on-entry' is called interactively, it prompts for FUNCTION-NAME in the minibuffer. If the function is already set up to invoke the debugger on entry, `debug-on-entry' does nothing. `debug-on-entry' always returns FUNCTION-NAME. *Note:* if you redefine a function after using `debug-on-entry' on it, the code to enter the debugger is discarded by the redefinition. In effect, redefining the function cancels the break-on-entry feature for that function. (defun fact (n) (if (zerop n) 1 (* n (fact (1- n))))) => fact (debug-on-entry 'fact) => fact (fact 3) ------ Buffer: *Backtrace* ------ Entering: * fact(3) eval-region(4870 4878 t) byte-code("...") eval-last-sexp(nil) (let ...) eval-insert-last-sexp(nil) * call-interactively(eval-insert-last-sexp) ------ Buffer: *Backtrace* ------ (symbol-function 'fact) => (lambda (n) (debug (quote debug)) (if (zerop n) 1 (* n (fact (1- n))))) - Command: cancel-debug-on-entry FUNCTION-NAME This function undoes the effect of `debug-on-entry' on FUNCTION-NAME. When called interactively, it prompts for FUNCTION-NAME in the minibuffer. If FUNCTION-NAME is `nil' or the empty string, it cancels break-on-entry for all functions. Calling `cancel-debug-on-entry' does nothing to a function which is not currently set up to break on entry. It always returns FUNCTION-NAME. Explicit Entry to the Debugger ------------------------------ You can cause the debugger to be called at a certain point in your program by writing the expression `(debug)' at that point. To do this, visit the source file, insert the text `(debug)' at the proper place, and type `C-M-x'. *Warning:* if you do this for temporary debugging purposes, be sure to undo this insertion before you save the file! The place where you insert `(debug)' must be a place where an additional form can be evaluated and its value ignored. (If the value of `(debug)' isn't ignored, it will alter the execution of the program!) The most common suitable places are inside a `progn' or an implicit `progn' (*note Sequencing::.). Using the Debugger ------------------ When the debugger is entered, it displays the previously selected buffer in one window and a buffer named `*Backtrace*' in another window. The backtrace buffer contains one line for each level of Lisp function execution currently going on. At the beginning of this buffer is a message describing the reason that the debugger was invoked (such as the error message and associated data, if it was invoked due to an error). The backtrace buffer is read-only and uses a special major mode, Debugger mode, in which letters are defined as debugger commands. The usual Emacs editing commands are available; thus, you can switch windows to examine the buffer that was being edited at the time of the error, switch buffers, visit files, or do any other sort of editing. However, the debugger is a recursive editing level (*note Recursive Editing::.) and it is wise to go back to the backtrace buffer and exit the debugger (with the `q' command) when you are finished with it. Exiting the debugger gets out of the recursive edit and kills the backtrace buffer. The backtrace buffer shows you the functions that are executing and their argument values. It also allows you to specify a stack frame by moving point to the line describing that frame. (A stack frame is the place where the Lisp interpreter records information about a particular invocation of a function.) The frame whose line point is on is considered the "current frame". Some of the debugger commands operate on the current frame. The debugger itself must be run byte-compiled, since it makes assumptions about how many stack frames are used for the debugger itself. These assumptions are false if the debugger is running interpreted. Debugger Commands ----------------- Inside the debugger (in Debugger mode), these special commands are available in addition to the usual cursor motion commands. (Keep in mind that all the usual facilities of Emacs, such as switching windows or buffers, are still available.) The most important use of debugger commands is for stepping through code, so that you can see how control flows. The debugger can step through the control structures of an interpreted function, but cannot do so in a byte-compiled function. If you would like to step through a byte-compiled function, replace it with an interpreted definition of the same function. (To do this, visit the source for the function and type `C-M-x' on its definition.) Here is a list of Debugger mode commands: `c' Exit the debugger and continue execution. When continuing is possible, it resumes execution of the program as if the debugger had never been entered (aside from any side-effects that you caused by changing variable values or data structures while inside the debugger). Continuing is possible after entry to the debugger due to function entry or exit, explicit invocation, or quitting. You cannot continue if the debugger was entered because of an error. `d' Continue execution, but enter the debugger the next time any Lisp function is called. This allows you to step through the subexpressions of an expression, seeing what values the subexpressions compute, and what else they do. The stack frame made for the function call which enters the debugger in this way will be flagged automatically so that the debugger will be called again when the frame is exited. You can use the `u' command to cancel this flag. `b' Flag the current frame so that the debugger will be entered when the frame is exited. Frames flagged in this way are marked with stars in the backtrace buffer. `u' Don't enter the debugger when the current frame is exited. This cancels a `b' command on that frame. The visible effect is to remove the star from the line in the backtrace buffer. `e' Read a Lisp expression in the minibuffer, evaluate it, and print the value in the echo area. The debugger alters certain important variables, and the current buffer, as part of its operation; `e' temporarily restores their values from outside the debugger, so you can examine and change them. This makes the debugger more transparent. By contrast, `M-:' does nothing special in the debugger; it shows you the variable values within the debugger. `R' Like `e', but also save the result of evaluation in the buffer `*Debugger-record*'. `q' Terminate the program being debugged; return to top-level Emacs command execution. If the debugger was entered due to a `C-g' but you really want to quit, and not debug, use the `q' command. `r' Return a value from the debugger. The value is computed by reading an expression with the minibuffer and evaluating it. The `r' command is useful when the debugger was invoked due to exit from a Lisp call frame (as requested with `b' or by entering the frame with `d'); then the value specified in the `r' command is used as the value of that frame. It is also useful if you call `debug' and use its return value. Otherwise, `r' has the same effect as `c', and the specified return value does not matter. You can't use `r' when the debugger was entered due to an error. Invoking the Debugger --------------------- Here we describe in full detail the function `debug' that is used to invoke the debugger. - Function: debug &rest DEBUGGER-ARGS This function enters the debugger. It switches buffers to a buffer named `*Backtrace*' (or `*Backtrace*<2>' if it is the second recursive entry to the debugger, etc.), and fills it with information about the stack of Lisp function calls. It then enters a recursive edit, showing the backtrace buffer in Debugger mode. The Debugger mode `c' and `r' commands exit the recursive edit; then `debug' switches back to the previous buffer and returns to whatever called `debug'. This is the only way the function `debug' can return to its caller. The use of the DEBUGGER-ARGS is that `debug' displays the rest of its arguments at the top of the `*Backtrace*' buffer, so that the user can see them. Except as described below, this is the *only* way these arguments are used. However, certain values for first argument to `debug' have a special significance. (Normally, these values are used only by the internals of Emacs, and not by programmers calling `debug'.) Here is a table of these special values: `lambda' A first argument of `lambda' means `debug' was called because of entry to a function when `debug-on-next-call' was non-`nil'. The debugger displays `Entering:' as a line of text at the top of the buffer. `debug' `debug' as first argument indicates a call to `debug' because of entry to a function that was set to debug on entry. The debugger displays `Entering:', just as in the `lambda' case. It also marks the stack frame for that function so that it will invoke the debugger when exited. `t' When the first argument is `t', this indicates a call to `debug' due to evaluation of a list form when `debug-on-next-call' is non-`nil'. The debugger displays the following as the top line in the buffer: Beginning evaluation of function call form: `exit' When the first argument is `exit', it indicates the exit of a stack frame previously marked to invoke the debugger on exit. The second argument given to `debug' in this case is the value being returned from the frame. The debugger displays `Return value:' in the top line of the buffer, followed by the value being returned. `error' When the first argument is `error', the debugger indicates that it is being entered because an error or `quit' was signaled and not handled, by displaying `Signaling:' followed by the error signaled and any arguments to `signal'. For example, (let ((debug-on-error t)) (/ 1 0)) ------ Buffer: *Backtrace* ------ Signaling: (arith-error) /(1 0) ... ------ Buffer: *Backtrace* ------ If an error was signaled, presumably the variable `debug-on-error' is non-`nil'. If `quit' was signaled, then presumably the variable `debug-on-quit' is non-`nil'. `nil' Use `nil' as the first of the DEBUGGER-ARGS when you want to enter the debugger explicitly. The rest of the DEBUGGER-ARGS are printed on the top line of the buffer. You can use this feature to display messages--for example, to remind yourself of the conditions under which `debug' is called. Internals of the Debugger ------------------------- This section describes functions and variables used internally by the debugger. - Variable: debugger The value of this variable is the function to call to invoke the debugger. Its value must be a function of any number of arguments (or, more typically, the name of a function). Presumably this function will enter some kind of debugger. The default value of the variable is `debug'. The first argument that Lisp hands to the function indicates why it was called. The convention for arguments is detailed in the description of `debug'. - Command: backtrace This function prints a trace of Lisp function calls currently active. This is the function used by `debug' to fill up the `*Backtrace*' buffer. It is written in C, since it must have access to the stack to determine which function calls are active. The return value is always `nil'. In the following example, a Lisp expression calls `backtrace' explicitly. This prints the backtrace to the stream `standard-output': in this case, to the buffer `backtrace-output'. Each line of the backtrace represents one function call. The line shows the values of the function's arguments if they are all known. If they are still being computed, the line says so. The arguments of special forms are elided. (with-output-to-temp-buffer "backtrace-output" (let ((var 1)) (save-excursion (setq var (eval '(progn (1+ var) (list 'testing (backtrace)))))))) => nil ----------- Buffer: backtrace-output ------------ backtrace() (list ...computing arguments...) (progn ...) eval((progn (1+ var) (list (quote testing) (backtrace)))) (setq ...) (save-excursion ...) (let ...) (with-output-to-temp-buffer ...) eval-region(1973 2142 #) byte-code("... for eval-print-last-sexp ...") eval-print-last-sexp(nil) * call-interactively(eval-print-last-sexp) ----------- Buffer: backtrace-output ------------ The character `*' indicates a frame whose debug-on-exit flag is set. - Variable: debug-on-next-call If this variable is non-`nil', it says to call the debugger before the next `eval', `apply' or `funcall'. Entering the debugger sets `debug-on-next-call' to `nil'. The `d' command in the debugger works by setting this variable. - Function: backtrace-debug LEVEL FLAG This function sets the debug-on-exit flag of the stack frame LEVEL levels down the stack, giving it the value FLAG. If FLAG is non-`nil', this will cause the debugger to be entered when that frame later exits. Even a nonlocal exit through that frame will enter the debugger. This function is used only by the debugger. - Variable: command-debug-status This variable records the debugging status of the current interactive command. Each time a command is called interactively, this variable is bound to `nil'. The debugger can set this variable to leave information for future debugger invocations during the same command invocation. The advantage, for the debugger, of using this variable rather than an ordinary global variable is that the data will never carry over to a subsequent command invocation. - Function: backtrace-frame FRAME-NUMBER The function `backtrace-frame' is intended for use in Lisp debuggers. It returns information about what computation is happening in the stack frame FRAME-NUMBER levels down. If that frame has not evaluated the arguments yet (or is a special form), the value is `(nil FUNCTION ARG-FORMS...)'. If that frame has evaluated its arguments and called its function already, the value is `(t FUNCTION ARG-VALUES...)'. In the return value, FUNCTION is whatever was supplied as the CAR of the evaluated list, or a `lambda' expression in the case of a macro call. If the function has a `&rest' argument, that is represented as the tail of the list ARG-VALUES. If FRAME-NUMBER is out of range, `backtrace-frame' returns `nil'. Edebug ====== Edebug is a source-level debugger for Emacs Lisp programs with which you can: * Step through evaluation, stopping before and after each expression. * Set conditional or unconditional breakpoints. * Stop when a specified condition is true (the global break event). * Trace slow or fast, stopping briefly at each stop point, or at each breakpoint. * Display expression results and evaluate expressions as if outside of Edebug. * Automatically re-evaluate a list of expressions and display their results each time Edebug updates the display. * Output trace info on function enter and exit. * Stop when an error occurs. * Display a backtrace, omitting Edebug's own frames. * Specify argument evaluation for macros and defining forms. * Obtain rudimentary coverage testing and frequency counts. The first three sections below should tell you enough about Edebug to enable you to use it. Using Edebug ------------ To debug a Lisp program with Edebug, you must first "instrument" the Lisp code that you want to debug. A simple way to do this is to first move point into the definition of a function or macro and then do `C-u C-M-x' (`eval-defun' with a prefix argument). See *Note Instrumenting::, for alternative ways to instrument code. Once a function is instrumented, any call to the function activates Edebug. Activating Edebug may stop execution and let you step through the function, or it may update the display and continue execution while checking for debugging commands, depending on which Edebug execution mode you have selected. The default execution mode is step, which does stop execution. *Note Edebug Execution Modes::. Within Edebug, you normally view an Emacs buffer showing the source of the Lisp code you are debugging. This is referred to as the "source code buffer". This buffer is temporarily read-only. An arrow at the left margin indicates the line where the function is executing. Point initially shows where within the line the function is executing, but this ceases to be true if you move point yourself. If you instrument the definition of `fac' (shown below) and then execute `(fac 3)', here is what you normally see. Point is at the open-parenthesis before `if'. (defun fac (n) =>-!-(if (< 0 n) (* n (fac (1- n))) 1)) The places within a function where Edebug can stop execution are called "stop points". These occur both before and after each subexpression that is a list, and also after each variable reference. Here we show with periods the stop points found in the function `fac': (defun fac (n) .(if .(< 0 n.). .(* n. .(fac (1- n.).).). 1).) The special commands of Edebug are available in the source code buffer in addition to the commands of Emacs Lisp mode. For example, you can type the Edebug command to execute until the next stop point. If you type once after entry to `fac', here is the display you will see: (defun fac (n) =>(if -!-(< 0 n) (* n (fac (1- n))) 1)) When Edebug stops execution after an expression, it displays the expression's value in the echo area. Other frequently used commands are `b' to set a breakpoint at a stop point, `g' to execute until a breakpoint is reached, and `q' to exit Edebug and return to the top-level command loop. Type `?' to display a list of all Edebug commands. Instrumenting for Edebug ------------------------ In order to use Edebug to debug Lisp code, you must first "instrument" the code. Instrumenting code inserts additional code into it, to invoke Edebug at the proper places. Once you have loaded Edebug, the command `C-M-x' (`eval-defun') is redefined so that when invoked with a prefix argument on a definition, it instruments the definition before evaluating it. (The source code itself is not modified.) If the variable `edebug-all-defs' is non-`nil', that inverts the meaning of the prefix argument: then `C-M-x' instruments the definition *unless* it has a prefix argument. The default value of `edebug-all-defs' is `nil'. The command `M-x edebug-all-defs' toggles the value of the variable `edebug-all-defs'. If `edebug-all-defs' is non-`nil', then the commands `eval-region', `eval-current-buffer', and `eval-buffer' also instrument any definitions they evaluate. Similarly, `edebug-all-forms' controls whether `eval-region' should instrument *any* form, even non-defining forms. This doesn't apply to loading or evaluations in the minibuffer. The command `M-x edebug-all-forms' toggles this option. Another command, `M-x edebug-eval-top-level-form', is available to instrument any top-level form regardless of the values of `edebug-all-defs' and `edebug-all-forms'. While Edebug is active, the command `I' (`edebug-instrument-callee') instruments the definition of the function or macro called by the list form after point, if is not already instrumented. This is possible only if Edebug knows where to find the source for that function; after loading Edebug, `eval-region' records the position of every definition it evaluates, even if not instrumenting it. See also the `i' command (*note Jumping::.), which steps into the call after instrumenting the function. Edebug knows how to instrument all the standard special forms, `interactive' forms with an expression argument, anonymous lambda expressions, and other defining forms. Edebug cannot know what a user-defined macro will do with the arguments of a macro call, so you must tell it; see *Note Instrumenting Macro Calls::, for details. When Edebug is about to instrument code for the first time in a session, it runs the hook `edebug-setup-hook', then sets it to `nil'. You can use this to arrange to load Edebug specifications (*note Instrumenting Macro Calls::.) associated with a package you are using, but actually load them only if you use Edebug. To remove instrumentation from a definition, simply re-evaluate its definition in a way that does not instrument. There are two ways of evaluating forms that never instrument them: from a file with `load', and from the minibuffer with `eval-expression' (`M-:'). If Edebug detects a syntax error while instrumenting, it leaves point at the erroneous code and signals an `invalid-read-syntax' error. *Note Edebug Eval::, for other evaluation functions available inside of Edebug. Edebug Execution Modes ---------------------- Edebug supports several execution modes for running the program you are debugging. We call these alternatives "Edebug execution modes"; do not confuse them with major or minor modes. The current Edebug execution mode determines how far Edebug continues execution before stopping--whether it stops at each stop point, or continues to the next breakpoint, for example--and how much Edebug displays the progress of the evaluation before it stops. Normally, you specify the Edebug execution mode by typing a command to continue the program in a certain mode. Here is a table of these commands. All except for `S' resume execution of the program, at least for a certain distance. `S' Stop: don't execute any more of the program for now, just wait for more Edebug commands (`edebug-stop'). `' Step: stop at the next stop point encountered (`edebug-step-mode'). `n' Next: stop at the next stop point encountered after an expression (`edebug-next-mode'). Also see `edebug-forward-sexp' in *Note Edebug Misc::. `t' Trace: pause one second at each Edebug stop point (`edebug-trace-mode'). `T' Rapid trace: update the display at each stop point, but don't actually pause (`edebug-Trace-fast-mode'). `g' Go: run until the next breakpoint (`edebug-go-mode'). *Note Breakpoints::. `c' Continue: pause one second at each breakpoint, and then continue (`edebug-continue-mode'). `C' Rapid continue: move point to each breakpoint, but don't pause (`edebug-Continue-fast-mode'). `G' Go non-stop: ignore breakpoints (`edebug-Go-nonstop-mode'). You can still stop the program by typing `S', or any editing command. In general, the execution modes earlier in the above list run the program more slowly or stop sooner than the modes later in the list. While executing or tracing, you can interrupt the execution by typing any Edebug command. Edebug stops the program at the next stop point and then executes the command you typed. For example, typing `t' during execution switches to trace mode at the next stop point. You can use `S' to stop execution without doing anything else. If your function happens to read input, a character you type intending to interrupt execution may be read by the function instead. You can avoid such unintended results by paying attention to when your program wants input. Keyboard macros containing the commands in this section do not completely work: exiting from Edebug, to resume the program, loses track of the keyboard macro. This is not easy to fix. Also, defining or executing a keyboard macro outside of Edebug does not affect commands inside Edebug. This is usually an advantage. But see the `edebug-continue-kbd-macro' option (*note Edebug Options::.). When you enter a new Edebug level, the initial execution mode comes from the value of the variable `edebug-initial-mode'. By default, this specifies step mode. Note that you may reenter the same Edebug level several times if, for example, an instrumented function is called several times from one command. Jumping ------- The commands described in this section execute until they reach a specified location. All except `i' make a temporary breakpoint to establish the place to stop, then switch to go mode. Any other breakpoint reached before the intended stop point will also stop execution. *Note Breakpoints::, for the details on breakpoints. These commands may fail to work as expected in case of nonlocal exit, because a nonlocal exit can bypass the temporary breakpoint where you expected the program to stop. `h' Proceed to the stop point near where point is (`edebug-goto-here'). `f' Run the program forward over one expression (`edebug-forward-sexp'). `o' Run the program until the end of the containing sexp. `i' Step into the function or macro called by the form after point. The `h' command proceeds to the stop point near the current location of point, using a temporary breakpoint. See *Note Breakpoints::, for more information about breakpoints. The `f' command runs the program forward over one expression. More precisely, it sets a temporary breakpoint at the position that `C-M-f' would reach, then executes in go mode so that the program will stop at breakpoints. With a prefix argument N, the temporary breakpoint is placed N sexps beyond point. If the containing list ends before N more elements, then the place to stop is after the containing expression. Be careful that the position `C-M-f' finds is a place that the program will really get to; this may not be true in a `cond', for example. The `f' command does `forward-sexp' starting at point, rather than at the stop point, for flexibility. If you want to execute one expression *from the current stop point*, type `w' first, to move point there, and then type `f'. The `o' command continues "out of" an expression. It places a temporary breakpoint at the end of the sexp containing point. If the containing sexp is a function definition itself, `o' continues until just before the last sexp in the definition. If that is where you are now, it returns from the function and then stops. In other words, this command does not exit the currently executing function unless you are positioned after the last sexp. The `i' command steps into the function or macro called by the list form after point, and stops at its first stop point. Note that the form need not be the one about to be evaluated. But if the form is a function call about to be evaluated, remember to use this command before any of the arguments are evaluated, since otherwise it will be too late. The `i' command instruments the function or macro it's supposed to step into, if it isn't instrumented already. This is convenient, but keep in mind that the function or macro remains instrumented unless you explicitly arrange to deinstrument it. Miscellaneous Edebug Commands ----------------------------- Some miscellaneous Edebug commands are described here. `?' Display the help message for Edebug (`edebug-help'). `C-]' Abort one level back to the previous command level (`abort-recursive-edit'). `q' Return to the top level editor command loop (`top-level'). This exits all recursive editing levels, including all levels of Edebug activity. However, instrumented code protected with `unwind-protect' or `condition-case' forms may resume debugging. `Q' Like `q' but don't stop even for protected code (`top-level-nonstop'). `r' Redisplay the most recently known expression result in the echo area (`edebug-previous-result'). `d' Display a backtrace, excluding Edebug's own functions for clarity (`edebug-backtrace'). You cannot use debugger commands in the backtrace buffer in Edebug as you would in the standard debugger. The backtrace buffer is killed automatically when you continue execution. From the Edebug recursive edit, you may invoke commands that activate Edebug again recursively. Any time Edebug is active, you can quit to the top level with `q' or abort one recursive edit level with `C-]'. You can display a backtrace of all the pending evaluations with `d'. Breakpoints ----------- Edebug's step mode stops execution at the next stop point reached. There are three other ways to stop Edebug execution once it has started: breakpoints, the global break condition, and source breakpoints. While using Edebug, you can specify "breakpoints" in the program you are testing: points where execution should stop. You can set a breakpoint at any stop point, as defined in *Note Using Edebug::. For setting and unsetting breakpoints, the stop point that is affected is the first one at or after point in the source code buffer. Here are the Edebug commands for breakpoints: `b' Set a breakpoint at the stop point at or after point (`edebug-set-breakpoint'). If you use a prefix argument, the breakpoint is temporary (it turns off the first time it stops the program). `u' Unset the breakpoint (if any) at the stop point at or after point (`edebug-unset-breakpoint'). `x CONDITION ' Set a conditional breakpoint which stops the program only if CONDITION evaluates to a non-`nil' value (`edebug-set-conditional-breakpoint'). With a prefix argument, the breakpoint is temporary. `B' Move point to the next breakpoint in the current definition (`edebug-next-breakpoint'). While in Edebug, you can set a breakpoint with `b' and unset one with `u'. First move point to the Edebug stop point of your choice, then type `b' or `u' to set or unset a breakpoint there. Unsetting a breakpoint where none has been set has no effect. Re-evaluating or reinstrumenting a definition forgets all its breakpoints. A "conditional breakpoint" tests a condition each time the program gets there. Any errors that occur as a result of evaluating the condition are ignored, as if the result were `nil'. To set a conditional breakpoint, use `x', and specify the condition expression in the minibuffer. Setting a conditional breakpoint at a stop point that has a previously established conditional breakpoint puts the previous condition expression in the minibuffer so you can edit it. You can make a conditional or unconditional breakpoint "temporary" by using a prefix argument with the command to set the breakpoint. When a temporary breakpoint stops the program, it is automatically unset. Edebug always stops or pauses at a breakpoint except when the Edebug mode is Go-nonstop. In that mode, it ignores breakpoints entirely. To find out where your breakpoints are, use the `B' command, which moves point to the next breakpoint following point, within the same function, or to the first breakpoint if there are no following breakpoints. This command does not continue execution--it just moves point in the buffer. Global Break Condition ...................... A "global break condition" stops execution when a specified condition is satisfied, no matter where that may occur. Edebug evaluates the global break condition at every stop point. If it evaluates to a non-`nil' value, then execution stops or pauses depending on the execution mode, as if a breakpoint had been hit. If evaluating the condition gets an error, execution does not stop. The condition expression is stored in `edebug-global-break-condition'. You can specify a new expression using the `X' command (`edebug-set-global-break-condition'). The global break condition is the simplest way to find where in your code some event occurs, but it makes code run much more slowly. So you should reset the condition to `nil' when not using it. Source Breakpoints .................. All breakpoints in a definition are forgotten each time you reinstrument it. To make a breakpoint that won't be forgotten, you can write a "source breakpoint", which is simply a call to the function `edebug' in your source code. You can, of course, make such a call conditional. For example, in the `fac' function, insert the first line as shown below to stop when the argument reaches zero: (defun fac (n) (if (= n 0) (edebug)) (if (< 0 n) (* n (fac (1- n))) 1)) When the `fac' definition is instrumented and the function is called, the call to `edebug' acts as a breakpoint. Depending on the execution mode, Edebug stops or pauses there. If no instrumented code is being executed when `edebug' is called, that function calls `debug'. Trapping Errors --------------- Emacs normally displays an error message when an error is signaled and not handled with `condition-case'. While Edebug is active and executing instrumented code, it normally responds to all unhandled errors. You can customize this with the options `edebug-on-error' and `edebug-on-quit'; see *Note Edebug Options::. When Edebug responds to an error, it shows the last stop point encountered before the error. This may be the location of a call to a function which was not instrumented, within which the error actually occurred. For an unbound variable error, the last known stop point might be quite distant from the offending variable reference. In that case you might want to display a full backtrace (*note Edebug Misc::.). If you change `debug-on-error' or `debug-on-quit' while Edebug is active, these changes will be forgotten when Edebug becomes inactive. Furthermore, during Edebug's recursive edit, these variables are bound to the values they had outside of Edebug. Edebug Views ------------ These Edebug commands let you view aspects of the buffer and window status as they were before entry to Edebug. The outside window configuration is the collection of windows and contents that were in effect outside of Edebug. `v' Temporarily view the outside window configuration (`edebug-view-outside'). `p' Temporarily display the outside current buffer with point at its outside position (`edebug-bounce-point'). With a prefix argument N, pause for N seconds instead. `w' Move point back to the current stop point in the source code buffer (`edebug-where'). If you use this command in a different window displaying the same buffer, that window will be used instead to display the current definition in the future. `W' Toggle whether Edebug saves and restores the outside window configuration (`edebug-toggle-save-windows'). With a prefix argument, `W' only toggles saving and restoring of the selected window. To specify a window that is not displaying the source code buffer, you must use `C-x X W' from the global keymap. You can view the outside window configuration with `v' or just bounce to the point in the current buffer with `p', even if it is not normally displayed. After moving point, you may wish to jump back to the stop point with `w' from a source code buffer. Each time you use `W' to turn saving *off*, Edebug forgets the saved outside window configuration--so that even if you turn saving back *on*, the current window configuration remains unchanged when you next exit Edebug (by continuing the program). However, the automatic redisplay of `*edebug*' and `*edebug-trace*' may conflict with the buffers you wish to see unless you have enough windows open. Evaluation ---------- While within Edebug, you can evaluate expressions "as if" Edebug were not running. Edebug tries to be invisible to the expression's evaluation and printing. Evaluation of expressions that cause side effects will work as expected except for things that Edebug explicitly saves and restores. *Note The Outside Context::, for details on this process. `e EXP ' Evaluate expression EXP in the context outside of Edebug (`edebug-eval-expression'). That is, Edebug tries to minimize its interference with the evaluation. `M-: EXP ' Evaluate expression EXP in the context of Edebug itself. `C-x C-e' Evaluate the expression before point, in the context outside of Edebug (`edebug-eval-last-sexp'). Edebug supports evaluation of expressions containing references to lexically bound symbols created by the following constructs in `cl.el' (version 2.03 or later): `lexical-let', `macrolet', and `symbol-macrolet'. Evaluation List Buffer ---------------------- You can use the "evaluation list buffer", called `*edebug*', to evaluate expressions interactively. You can also set up the "evaluation list" of expressions to be evaluated automatically each time Edebug updates the display. `E' Switch to the evaluation list buffer `*edebug*' (`edebug-visit-eval-list'). In the `*edebug*' buffer you can use the commands of Lisp Interaction mode (*note Lisp Interaction: (emacs)Lisp Interaction.) as well as these special commands: `C-j' Evaluate the expression before point, in the outside context, and insert the value in the buffer (`edebug-eval-print-last-sexp'). `C-x C-e' Evaluate the expression before point, in the context outside of Edebug (`edebug-eval-last-sexp'). `C-c C-u' Build a new evaluation list from the contents of the buffer (`edebug-update-eval-list'). `C-c C-d' Delete the evaluation list group that point is in (`edebug-delete-eval-item'). `C-c C-w' Switch back to the source code buffer at the current stop point (`edebug-where'). You can evaluate expressions in the evaluation list window with `C-j' or `C-x C-e', just as you would in `*scratch*'; but they are evaluated in the context outside of Edebug. The expressions you enter interactively (and their results) are lost when you continue execution; but you can set up an "evaluation list" consisting of expressions to be evaluated each time execution stops. To do this, write one or more "evaluation list groups" in the evaluation list buffer. An evaluation list group consists of one or more Lisp expressions. Groups are separated by comment lines. The command `C-c C-u' (`edebug-update-eval-list') rebuilds the evaluation list, scanning the buffer and using the first expression of each group. (The idea is that the second expression of the group is the value previously computed and displayed.) Each entry to Edebug redisplays the evaluation list by inserting each expression in the buffer, followed by its current value. It also inserts comment lines so that each expression becomes its own group. Thus, if you type `C-c C-u' again without changing the buffer text, the evaluation list is effectively unchanged. If an error occurs during an evaluation from the evaluation list, the error message is displayed in a string as if it were the result. Therefore, expressions that use variables not currently valid do not interrupt your debugging. Here is an example of what the evaluation list window looks like after several expressions have been added to it: (current-buffer) # ;--------------------------------------------------------------- (selected-window) # ;--------------------------------------------------------------- (point) 196 ;--------------------------------------------------------------- bad-var "Symbol's value as variable is void: bad-var" ;--------------------------------------------------------------- (recursion-depth) 0 ;--------------------------------------------------------------- this-command eval-last-sexp ;--------------------------------------------------------------- To delete a group, move point into it and type `C-c C-d', or simply delete the text for the group and update the evaluation list with `C-c C-u'. To add a new expression to the evaluation list, insert the expression at a suitable place, and insert a new comment line. (You need not insert dashes in the comment line--its contents don't matter.) Then type `C-c C-u'. After selecting `*edebug*', you can return to the source code buffer with `C-c C-w'. The `*edebug*' buffer is killed when you continue execution, and recreated next time it is needed. Printing in Edebug ------------------ If an expression in your program produces a value containing circular list structure, you may get an error when Edebug attempts to print it. One way to cope with circular structure is to set `print-length' or `print-level' to truncate the printing. Edebug does this for you; it binds `print-length' and `print-level' to 50 if they were `nil'. (Actually, the variables `edebug-print-length' and `edebug-print-level' specify the values to use within Edebug.) *Note Output Variables::. - User Option: edebug-print-length If non-`nil', bind `print-length' to this while printing results in Edebug. The default value is `50'. - User Option: edebug-print-level If non-`nil', bind `print-level' to this while printing results in Edebug. The default value is `50'. You can also print circular structures and structures that share elements more informatively by using the `cust-print' package. To load `cust-print' and activate custom printing only for Edebug, simply use the command `M-x edebug-install-custom-print'. To restore the standard print functions, use `M-x edebug-uninstall-custom-print'. Here is an example of code that creates a circular structure: (setq a '(x y)) (setcar a a) Custom printing prints this as `Result: #1=(#1# y)'. The `#1=' notation labels the structure that follows it with the label `1', and the `#1#' notation references the previously labeled structure. This notation is used for any shared elements of lists or vectors. - User Option: edebug-print-circle If non-`nil', bind `print-circle' to this while printing results in Edebug. The default value is `nil'. Other programs can also use custom printing; see `cust-print.el' for details. Trace Buffer ------------ Edebug can record an execution trace, storing it in a buffer named `*edebug-trace*'. This is a log of function calls and returns, showing the function names and their arguments and values. To enable trace recording, set `edebug-trace' to a non-`nil' value. Making a trace buffer is not the same thing as using trace execution mode (*note Edebug Execution Modes::.). When trace recording is enabled, each function entry and exit adds lines to the trace buffer. A function entry record looks like `::::{' followed by the function name and argument values. A function exit record looks like `::::}' followed by the function name and result of the function. The number of `:'s in an entry shows its recursion depth. You can use the braces in the trace buffer to find the matching beginning or end of function calls. You can customize trace recording for function entry and exit by redefining the functions `edebug-print-trace-before' and `edebug-print-trace-after'. - Macro: edebug-tracing STRING BODY... This macro requests additional trace information around the execution of the BODY forms. The argument STRING specifies text to put in the trace buffer. All the arguments are evaluated. `edebug-tracing' returns the value of the last form in BODY. - Function: edebug-trace FORMAT-STRING &rest FORMAT-ARGS This function inserts text in the trace buffer. It computes the text with `(apply 'format FORMAT-STRING FORMAT-ARGS)'. It also appends a newline to separate entries. `edebug-tracing' and `edebug-trace' insert lines in the trace buffer whenever they are called, even if Edebug is not active. Adding text to the trace buffer also scrolls its window to show the last lines inserted. Coverage Testing ---------------- Edebug provides rudimentary coverage testing and display of execution frequency. Coverage testing works by comparing the result of each expression with the previous result; each form in the program is considered "covered" if it has returned two different values since you began testing coverage in the current Emacs session. Thus, to do coverage testing on your program, execute it under various conditions and note whether it behaves correctly; Edebug will tell you when you have tried enough different conditions that each form has returned two different values. Coverage testing makes execution slower, so it is only done if `edebug-test-coverage' is non-`nil'. Frequency counting is performed for all execution of an instrumented function, even if the execution mode is Go-nonstop, and regardless of whether coverage testing is enabled. Use `M-x edebug-display-freq-count' to display both the coverage information and the frequency counts for a definition. - Command: edebug-display-freq-count This command displays the frequency count data for each line of the current definition. The frequency counts appear as comment lines after each line of code, and you can undo all insertions with one `undo' command. The counts appear under the `(' before an expression or the `)' after an expression, or on the last character of a variable. To simplify the display, a count is not shown if it is equal to the count of an earlier expression on the same line. The character `=' following the count for an expression says that the expression has returned the same value each time it was evaluated. In other words, it is not yet "covered" for coverage testing purposes. To clear the frequency count and coverage data for a definition, simply reinstrument it with `eval-defun'. For example, after evaluating `(fac 5)' with a source breakpoint, and setting `edebug-test-coverage' to `t', when the breakpoint is reached, the frequency data looks like this: (defun fac (n) (if (= n 0) (edebug)) ;#6 1 0 =5 (if (< 0 n) ;#5 = (* n (fac (1- n))) ;# 5 0 1)) ;# 0 The comment lines show that `fac' was called 6 times. The first `if' statement returned 5 times with the same result each time; the same is true of the condition on the second `if'. The recursive call of `fac' did not return at all. The Outside Context ------------------- Edebug tries to be transparent to the program you are debugging, but it does not succeed completely. Edebug also tries to be transparent when you evaluate expressions with `e' or with the evaluation list buffer, by temporarily restoring the outside context. This section explains precisely what context Edebug restores, and how Edebug fails to be completely transparent. Checking Whether to Stop ........................ Whenever Edebug is entered, it needs to save and restore certain data before even deciding whether to make trace information or stop the program. * `max-lisp-eval-depth' and `max-specpdl-size' are both incremented once to reduce Edebug's impact on the stack. You could, however, still run out of stack space when using Edebug. * The state of keyboard macro execution is saved and restored. While Edebug is active, `executing-macro' is bound to `edebug-continue-kbd-macro'. Edebug Display Update ..................... When Edebug needs to display something (e.g., in trace mode), it saves the current window configuration from "outside" Edebug (*note Window Configurations::.). When you exit Edebug (by continuing the program), it restores the previous window configuration. Emacs redisplays only when it pauses. Usually, when you continue execution, the program comes back into Edebug at a breakpoint or after stepping without pausing or reading input in between. In such cases, Emacs never gets a chance to redisplay the "outside" configuration. What you see is the same window configuration as the last time Edebug was active, with no interruption. Entry to Edebug for displaying something also saves and restores the following data, but some of these are deliberately not restored if an error or quit signal occurs. * Which buffer is current, and the positions of point and the mark in the current buffer, are saved and restored. * The outside window configuration is saved and restored if `edebug-save-windows' is non-`nil' (*note Edebug Display Update::.). The window configuration is not restored on error or quit, but the outside selected window *is* reselected even on error or quit in case a `save-excursion' is active. If the value of `edebug-save-windows' is a list, only the listed windows are saved and restored. The window start and horizontal scrolling of the source code buffer are not restored, however, so that the display remains coherent within Edebug. * The value of point in each displayed buffer is saved and restored if `edebug-save-displayed-buffer-points' is non-`nil'. * The variables `overlay-arrow-position' and `overlay-arrow-string' are saved and restored. So you can safely invoke Edebug from the recursive edit elsewhere in the same buffer. * `cursor-in-echo-area' is locally bound to `nil' so that the cursor shows up in the window. Edebug Recursive Edit ..................... When Edebug is entered and actually reads commands from the user, it saves (and later restores) these additional data: * The current match data. *Note Match Data::. * `last-command', `this-command', `last-command-char', `last-input-char', `last-input-event', `last-command-event', `last-event-frame', `last-nonmenu-event', and `track-mouse'. Commands used within Edebug do not affect these variables outside of Edebug. The key sequence returned by `this-command-keys' is changed by executing commands within Edebug and there is no way to reset the key sequence from Lisp. Edebug cannot save and restore the value of `unread-command-events'. Entering Edebug while this variable has a nontrivial value can interfere with execution of the program you are debugging. * Complex commands executed while in Edebug are added to the variable `command-history'. In rare cases this can alter execution. * Within Edebug, the recursion depth appears one deeper than the recursion depth outside Edebug. This is not true of the automatically updated evaluation list window. * `standard-output' and `standard-input' are bound to `nil' by the `recursive-edit', but Edebug temporarily restores them during evaluations. * The state of keyboard macro definition is saved and restored. While Edebug is active, `defining-kbd-macro' is bound to `edebug-continue-kbd-macro'. Instrumenting Macro Calls ------------------------- When Edebug instruments an expression that calls a Lisp macro, it needs additional information about the macro to do the job properly. This is because there is no a-priori way to tell which subexpressions of the macro call are forms to be evaluated. (Evaluation may occur explicitly in the macro body, or when the resulting expansion is evaluated, or any time later.) Therefore, you must define an Edebug specification for each macro that Edebug will encounter, to explain the format of calls to that macro. To do this, use `def-edebug-spec'. - Macro: def-edebug-spec MACRO SPECIFICATION Specify which expressions of a call to macro MACRO are forms to be evaluated. For simple macros, the SPECIFICATION often looks very similar to the formal argument list of the macro definition, but specifications are much more general than macro arguments. The MACRO argument can actually be any symbol, not just a macro name. Here is a simple example that defines the specification for the `for' example macro (*note Argument Evaluation::.), followed by an alternative, equivalent specification. (def-edebug-spec for (symbolp "from" form "to" form "do" &rest form)) (def-edebug-spec for (symbolp ['from form] ['to form] ['do body])) Here is a table of the possibilities for SPECIFICATION and how each directs processing of arguments. `t' All arguments are instrumented for evaluation. `0' None of the arguments is instrumented. a symbol The symbol must have an Edebug specification which is used instead. This indirection is repeated until another kind of specification is found. This allows you to inherit the specification from another macro. a list The elements of the list describe the types of the arguments of a calling form. The possible elements of a specification list are described in the following sections. Specification List .................. A "specification list" is required for an Edebug specification if some arguments of a macro call are evaluated while others are not. Some elements in a specification list match one or more arguments, but others modify the processing of all following elements. The latter, called "specification keywords", are symbols beginning with `&' (such as `&optional'). A specification list may contain sublists which match arguments that are themselves lists, or it may contain vectors used for grouping. Sublists and groups thus subdivide the specification list into a hierarchy of levels. Specification keywords apply only to the remainder of the sublist or group they are contained in. When a specification list involves alternatives or repetition, matching it against an actual macro call may require backtracking. *Note Backtracking::, for more details. Edebug specifications provide the power of regular expression matching, plus some context-free grammar constructs: the matching of sublists with balanced parentheses, recursive processing of forms, and recursion via indirect specifications. Here's a table of the possible elements of a specification list, with their meanings: `sexp' A single unevaluated Lisp object, which is not instrumented. `form' A single evaluated expression, which is instrumented. `place' A place to store a value, as in the Common Lisp `setf' construct. `body' Short for `&rest form'. See `&rest' below. `function-form' A function form: either a quoted function symbol, a quoted lambda expression, or a form (that should evaluate to a function symbol or lambda expression). This is useful when an argument that's a lambda expression might be quoted with `quote' rather than `function', since it instruments the body of the lambda expression either way. `lambda-expr' A lambda expression with no quoting. `&optional' All following elements in the specification list are optional; as soon as one does not match, Edebug stops matching at this level. To make just a few elements optional followed by non-optional elements, use `[&optional SPECS...]'. To specify that several elements must all match or none, use `&optional [SPECS...]'. See the `defun' example below. `&rest' All following elements in the specification list are repeated zero or more times. In the last repetition, however, it is not a problem if the expression runs out before matching all of the elements of the specification list. To repeat only a few elements, use `[&rest SPECS...]'. To specify several elements that must all match on every repetition, use `&rest [SPECS...]'. `&or' Each of the following elements in the specification list is an alternative. One of the alternatives must match, or the `&or' specification fails. Each list element following `&or' is a single alternative. To group two or more list elements as a single alternative, enclose them in `[...]'. `¬' Each of the following elements is matched as alternatives as if by using `&or', but if any of them match, the specification fails. If none of them match, nothing is matched, but the `¬' specification succeeds. `&define' Indicates that the specification is for a defining form. The defining form itself is not instrumented (that is, Edebug does not stop before and after the defining form), but forms inside it typically will be instrumented. The `&define' keyword should be the first element in a list specification. `nil' This is successful when there are no more arguments to match at the current argument list level; otherwise it fails. See sublist specifications and the backquote example below. `gate' No argument is matched but backtracking through the gate is disabled while matching the remainder of the specifications at this level. This is primarily used to generate more specific syntax error messages. See *Note Backtracking::, for more details. Also see the `let' example below. `OTHER-SYMBOL' Any other symbol in a specification list may be a predicate or an indirect specification. If the symbol has an Edebug specification, this "indirect specification" should be either a list specification that is used in place of the symbol, or a function that is called to process the arguments. The specification may be defined with `def-edebug-spec' just as for macros. See the `defun' example below. Otherwise, the symbol should be a predicate. The predicate is called with the argument and the specification fails if the predicate returns `nil'. In either case, that argument is not instrumented. Some suitable predicates include `symbolp', `integerp', `stringp', `vectorp', and `atom'. `[ELEMENTS...]' A vector of elements groups the elements into a single "group specification". Its meaning has nothing to do with vectors. `"STRING"' The argument should be a symbol named STRING. This specification is equivalent to the quoted symbol, `'SYMBOL', where the name of SYMBOL is the STRING, but the string form is preferred. `(vector ELEMENTS...)' The argument should be a vector whose elements must match the ELEMENTS in the specification. See the backquote example below. `(ELEMENTS...)' Any other list is a "sublist specification" and the argument must be a list whose elements match the specification ELEMENTS. A sublist specification may be a dotted list and the corresponding list argument may then be a dotted list. Alternatively, the last CDR of a dotted list specification may be another sublist specification (via a grouping or an indirect specification, e.g., `(spec . [(more specs...)])') whose elements match the non-dotted list arguments. This is useful in recursive specifications such as in the backquote example below. Also see the description of a `nil' specification above for terminating such recursion. Note that a sublist specification written as `(specs . nil)' is equivalent to `(specs)', and `(specs . (sublist-elements...))' is equivalent to `(specs sublist-elements...)'. Here is a list of additional specifications that may appear only after `&define'. See the `defun' example below. `name' The argument, a symbol, is the name of the defining form. A defining form is not required to have a name field; and it may have multiple name fields. `:name' This construct does not actually match an argument. The element following `:name' should be a symbol; it is used as an additional name component for the definition. You can use this to add a unique, static component to the name of the definition. It may be used more than once. `arg' The argument, a symbol, is the name of an argument of the defining form. However, lambda-list keywords (symbols starting with `&') are not allowed. `lambda-list' This matches a lambda list--the argument list of a lambda expression. `def-body' The argument is the body of code in a definition. This is like `body', described above, but a definition body must be instrumented with a different Edebug call that looks up information associated with the definition. Use `def-body' for the highest level list of forms within the definition. `def-form' The argument is a single, highest-level form in a definition. This is like `def-body', except use this to match a single form rather than a list of forms. As a special case, `def-form' also means that tracing information is not output when the form is executed. See the `interactive' example below. Backtracking in Specifications .............................. If a specification fails to match at some point, this does not necessarily mean a syntax error will be signaled; instead, "backtracking" will take place until all alternatives have been exhausted. Eventually every element of the argument list must be matched by some element in the specification, and every required element in the specification must match some argument. When a syntax error is detected, it might not be reported until much later after higher-level alternatives have been exhausted, and with the point positioned further from the real error. But if backtracking is disabled when an error occurs, it can be reported immediately. Note that backtracking is also reenabled automatically in several situations; it is reenabled when a new alternative is established by `&optional', `&rest', or `&or', or at the start of processing a sublist, group, or indirect specification. The effect of enabling or disabling backtracking is limited to the remainder of the level currently being processed and lower levels. Backtracking is disabled while matching any of the form specifications (that is, `form', `body', `def-form', and `def-body'). These specifications will match any form so any error must be in the form itself rather than at a higher level. Backtracking is also disabled after successfully matching a quoted symbol or string specification, since this usually indicates a recognized construct. But if you have a set of alternative constructs that all begin with the same symbol, you can usually work around this constraint by factoring the symbol out of the alternatives, e.g., `["foo" &or [first case] [second case] ...]'. Most needs are satisfied by these two ways that bactracking is automatically disabled, but occasionally it is useful to explicitly disable backtracking by using the `gate' specification. This is useful when you know that no higher alternatives could apply. See the example of the `let' specification. Specification Examples ...................... It may be easier to understand Edebug specifications by studying the examples provided here. A `let' special form has a sequence of bindings and a body. Each of the bindings is either a symbol or a sublist with a symbol and optional expression. In the specification below, notice the `gate' inside of the sublist to prevent backtracking once a sublist is found. (def-edebug-spec let ((&rest &or symbolp (gate symbolp &optional form)) body)) Edebug uses the following specifications for `defun' and `defmacro' and the associated argument list and `interactive' specifications. It is necessary to handle interactive forms specially since an expression argument it is actually evaluated outside of the function body. (def-edebug-spec defmacro defun) ; Indirect ref to `defun' spec. (def-edebug-spec defun (&define name lambda-list [&optional stringp] ; Match the doc string, if present. [&optional ("interactive" interactive)] def-body)) (def-edebug-spec lambda-list (([&rest arg] [&optional ["&optional" arg &rest arg]] &optional ["&rest" arg] ))) (def-edebug-spec interactive (&optional &or stringp def-form)) ; Notice: `def-form' The specification for backquote below illustrates how to match dotted lists and use `nil' to terminate recursion. It also illustrates how components of a vector may be matched. (The actual specification defined by Edebug does not support dotted lists because doing so causes very deep recursion that could fail.) (def-edebug-spec ` (backquote-form)) ; Alias just for clarity. (def-edebug-spec backquote-form (&or ([&or "," ",@"] &or ("quote" backquote-form) form) (backquote-form . [&or nil backquote-form]) (vector &rest backquote-form) sexp)) Edebug Options -------------- These options affect the behavior of Edebug: - User Option: edebug-setup-hook Functions to call before Edebug is used. Each time it is set to a new value, Edebug will call those functions once and then `edebug-setup-hook' is reset to `nil'. You could use this to load up Edebug specifications associated with a package you are using but only when you also use Edebug. *Note Instrumenting::. - User Option: edebug-all-defs If this is non-`nil', normal evaluation of defining forms such as `defun' and `defmacro' instruments them for Edebug. This applies to `eval-defun', `eval-region', `eval-buffer', and `eval-current-buffer'. Use the command `M-x edebug-all-defs' to toggle the value of this option. *Note Instrumenting::. - User Option: edebug-all-forms If this is non-`nil', the commands `eval-defun', `eval-region', `eval-buffer', and `eval-current-buffer' instrument all forms, even those that don't define anything. This doesn't apply to loading or evaluations in the minibuffer. Use the command `M-x edebug-all-forms' to toggle the value of this option. *Note Instrumenting::. - User Option: edebug-save-windows If this is non-`nil', Edebug saves and restores the window configuration. That takes some time, so if your program does not care what happens to the window configurations, it is better to set this variable to `nil'. If the value is a list, only the listed windows are saved and restored. You can use the `W' command in Edebug to change this variable interactively. *Note Edebug Display Update::. - User Option: edebug-save-displayed-buffer-points If this is non-`nil', Edebug saves and restores point in all displayed buffers. Saving and restoring point in other buffers is necessary if you are debugging code that changes the point of a buffer which is displayed in a non-selected window. If Edebug or the user then selects the window, point in that buffer will move to the window's value of point. Saving and restoring point in all buffers is expensive, since it requires selecting each window twice, so enable this only if you need it. *Note Edebug Display Update::. - User Option: edebug-initial-mode If this variable is non-`nil', it specifies the initial execution mode for Edebug when it is first activated. Possible values are `step', `next', `go', `Go-nonstop', `trace', `Trace-fast', `continue', and `Continue-fast'. The default value is `step'. *Note Edebug Execution Modes::. - User Option: edebug-trace Non-`nil' means display a trace of function entry and exit. Tracing output is displayed in a buffer named `*edebug-trace*', one function entry or exit per line, indented by the recursion level. The default value is `nil'. Also see `edebug-tracing', in *Note Trace Buffer::. - User Option: edebug-test-coverage If non-`nil', Edebug tests coverage of all expressions debugged. *Note Coverage Testing::. - User Option: edebug-continue-kbd-macro If non-`nil', continue defining or executing any keyboard macro that is executing outside of Edebug. Use this with caution since it is not debugged. *Note Edebug Execution Modes::. - User Option: edebug-on-error Edebug binds `debug-on-error' to this value, if `debug-on-error' was previously `nil'. *Note Trapping Errors::. - User Option: edebug-on-quit Edebug binds `debug-on-quit' to this value, if `debug-on-quit' was previously `nil'. *Note Trapping Errors::. If you change the values of `edebug-on-error' or `edebug-on-quit' while Edebug is active, their values won't be used until the *next* time Edebug is invoked via a new command. - User Option: edebug-global-break-condition If non-`nil', an expression to test for at every stop point. If the result is non-nil, then break. Errors are ignored. *Note Global Break Condition::. Debugging Invalid Lisp Syntax ============================= The Lisp reader reports invalid syntax, but cannot say where the real problem is. For example, the error "End of file during parsing" in evaluating an expression indicates an excess of open parentheses (or square brackets). The reader detects this imbalance at the end of the file, but it cannot figure out where the close parenthesis should have been. Likewise, "Invalid read syntax: ")"" indicates an excess close parenthesis or missing open parenthesis, but does not say where the missing parenthesis belongs. How, then, to find what to change? If the problem is not simply an imbalance of parentheses, a useful technique is to try `C-M-e' at the beginning of each defun, and see if it goes to the place where that defun appears to end. If it does not, there is a problem in that defun. However, unmatched parentheses are the most common syntax errors in Lisp, and we can give further advice for those cases. (In addition, just moving point through the code with Show Paren mode enabled might find the mismatch.) Excess Open Parentheses ----------------------- The first step is to find the defun that is unbalanced. If there is an excess open parenthesis, the way to do this is to insert a close parenthesis at the end of the file and type `C-M-b' (`backward-sexp'). This will move you to the beginning of the defun that is unbalanced. (Then type `C- C-_ C-u C-' to set the mark there, undo the insertion of the close parenthesis, and finally return to the mark.) The next step is to determine precisely what is wrong. There is no way to be sure of this except by studying the program, but often the existing indentation is a clue to where the parentheses should have been. The easiest way to use this clue is to reindent with `C-M-q' and see what moves. *But don't do this yet!* Keep reading, first. Before you do this, make sure the defun has enough close parentheses. Otherwise, `C-M-q' will get an error, or will reindent all the rest of the file until the end. So move to the end of the defun and insert a close parenthesis there. Don't use `C-M-e' to move there, since that too will fail to work until the defun is balanced. Now you can go to the beginning of the defun and type `C-M-q'. Usually all the lines from a certain point to the end of the function will shift to the right. There is probably a missing close parenthesis, or a superfluous open parenthesis, near that point. (However, don't assume this is true; study the code to make sure.) Once you have found the discrepancy, undo the `C-M-q' with `C-_', since the old indentation is probably appropriate to the intended parentheses. After you think you have fixed the problem, use `C-M-q' again. If the old indentation actually fit the intended nesting of parentheses, and you have put back those parentheses, `C-M-q' should not change anything. Excess Close Parentheses ------------------------ To deal with an excess close parenthesis, first insert an open parenthesis at the beginning of the file, back up over it, and type `C-M-f' to find the end of the unbalanced defun. (Then type `C- C-_ C-u C-' to set the mark there, undo the insertion of the open parenthesis, and finally return to the mark.) Then find the actual matching close parenthesis by typing `C-M-f' at the beginning of that defun. This will leave you somewhere short of the place where the defun ought to end. It is possible that you will find a spurious close parenthesis in that vicinity. If you don't see a problem at that point, the next thing to do is to type `C-M-q' at the beginning of the defun. A range of lines will probably shift left; if so, the missing open parenthesis or spurious close parenthesis is probably near the first of those lines. (However, don't assume this is true; study the code to make sure.) Once you have found the discrepancy, undo the `C-M-q' with `C-_', since the old indentation is probably appropriate to the intended parentheses. After you think you have fixed the problem, use `C-M-q' again. If the old indentation actually fit the intended nesting of parentheses, and you have put back those parentheses, `C-M-q' should not change anything. Debugging Problems in Compilation ================================= When an error happens during byte compilation, it is normally due to invalid syntax in the program you are compiling. The compiler prints a suitable error message in the `*Compile-Log*' buffer, and then stops. The message may state a function name in which the error was found, or it may not. Either way, here is how to find out where in the file the error occurred. What you should do is switch to the buffer ` *Compiler Input*'. (Note that the buffer name starts with a space, so it does not show up in `M-x list-buffers'.) This buffer contains the program being compiled, and point shows how far the byte compiler was able to read. If the error was due to invalid Lisp syntax, point shows exactly where the invalid syntax was *detected*. The cause of the error is not necessarily near by! Use the techniques in the previous section to find the error. If the error was detected while compiling a form that had been read successfully, then point is located at the end of the form. In this case, this technique can't localize the error precisely, but can still show you which function to check. Reading and Printing Lisp Objects ********************************* "Printing" and "reading" are the operations of converting Lisp objects to textual form and vice versa. They use the printed representations and read syntax described in *Note Lisp Data Types::. This chapter describes the Lisp functions for reading and printing. It also describes "streams", which specify where to get the text (if reading) or where to put it (if printing). Introduction to Reading and Printing ==================================== "Reading" a Lisp object means parsing a Lisp expression in textual form and producing a corresponding Lisp object. This is how Lisp programs get into Lisp from files of Lisp code. We call the text the "read syntax" of the object. For example, the text `(a . 5)' is the read syntax for a cons cell whose CAR is `a' and whose CDR is the number 5. "Printing" a Lisp object means producing text that represents that object--converting the object to its "printed representation" (*note Printed Representation::.). Printing the cons cell described above produces the text `(a . 5)'. Reading and printing are more or less inverse operations: printing the object that results from reading a given piece of text often produces the same text, and reading the text that results from printing an object usually produces a similar-looking object. For example, printing the symbol `foo' produces the text `foo', and reading that text returns the symbol `foo'. Printing a list whose elements are `a' and `b' produces the text `(a b)', and reading that text produces a list (but not the same list) with elements `a' and `b'. However, these two operations are not precisely inverses. There are three kinds of exceptions: * Printing can produce text that cannot be read. For example, buffers, windows, frames, subprocesses and markers print as text that starts with `#'; if you try to read this text, you get an error. There is no way to read those data types. * One object can have multiple textual representations. For example, `1' and `01' represent the same integer, and `(a b)' and `(a . (b))' represent the same list. Reading will accept any of the alternatives, but printing must choose one of them. * Comments can appear at certain points in the middle of an object's read sequence without affecting the result of reading it. Input Streams ============= Most of the Lisp functions for reading text take an "input stream" as an argument. The input stream specifies where or how to get the characters of the text to be read. Here are the possible types of input stream: BUFFER The input characters are read from BUFFER, starting with the character directly after point. Point advances as characters are read. MARKER The input characters are read from the buffer that MARKER is in, starting with the character directly after the marker. The marker position advances as characters are read. The value of point in the buffer has no effect when the stream is a marker. STRING The input characters are taken from STRING, starting at the first character in the string and using as many characters as required. FUNCTION The input characters are generated by FUNCTION, which must support two kinds of calls: * When it is called with no arguments, it should return the next character. * When it is called with one argument (always a character), FUNCTION should save the argument and arrange to return it on the next call. This is called "unreading" the character; it happens when the Lisp reader reads one character too many and wants to "put it back where it came from". In this case, it makes no difference what value FUNCTION returns. `t' `t' used as a stream means that the input is read from the minibuffer. In fact, the minibuffer is invoked once and the text given by the user is made into a string that is then used as the input stream. `nil' `nil' supplied as an input stream means to use the value of `standard-input' instead; that value is the "default input stream", and must be a non-`nil' input stream. SYMBOL A symbol as input stream is equivalent to the symbol's function definition (if any). Here is an example of reading from a stream that is a buffer, showing where point is located before and after: ---------- Buffer: foo ---------- This-!- is the contents of foo. ---------- Buffer: foo ---------- (read (get-buffer "foo")) => is (read (get-buffer "foo")) => the ---------- Buffer: foo ---------- This is the-!- contents of foo. ---------- Buffer: foo ---------- Note that the first read skips a space. Reading skips any amount of whitespace preceding the significant text. Here is an example of reading from a stream that is a marker, initially positioned at the beginning of the buffer shown. The value read is the symbol `This'. ---------- Buffer: foo ---------- This is the contents of foo. ---------- Buffer: foo ---------- (setq m (set-marker (make-marker) 1 (get-buffer "foo"))) => # (read m) => This m => # ;; Before the first space. Here we read from the contents of a string: (read "(When in) the course") => (When in) The following example reads from the minibuffer. The prompt is: `Lisp expression: '. (That is always the prompt used when you read from the stream `t'.) The user's input is shown following the prompt. (read t) => 23 ---------- Buffer: Minibuffer ---------- Lisp expression: 23 ---------- Buffer: Minibuffer ---------- Finally, here is an example of a stream that is a function, named `useless-stream'. Before we use the stream, we initialize the variable `useless-list' to a list of characters. Then each call to the function `useless-stream' obtains the next character in the list or unreads a character by adding it to the front of the list. (setq useless-list (append "XY()" nil)) => (88 89 40 41) (defun useless-stream (&optional unread) (if unread (setq useless-list (cons unread useless-list)) (prog1 (car useless-list) (setq useless-list (cdr useless-list))))) => useless-stream Now we read using the stream thus constructed: (read 'useless-stream) => XY useless-list => (40 41) Note that the open and close parentheses remain in the list. The Lisp reader encountered the open parenthesis, decided that it ended the input, and unread it. Another attempt to read from the stream at this point would read `()' and return `nil'. - Function: get-file-char This function is used internally as an input stream to read from the input file opened by the function `load'. Don't use this function yourself. Input Functions =============== This section describes the Lisp functions and variables that pertain to reading. In the functions below, STREAM stands for an input stream (see the previous section). If STREAM is `nil' or omitted, it defaults to the value of `standard-input'. An `end-of-file' error is signaled if reading encounters an unterminated list, vector, or string. - Function: read &optional STREAM This function reads one textual Lisp expression from STREAM, returning it as a Lisp object. This is the basic Lisp input function. - Function: read-from-string STRING &optional START END This function reads the first textual Lisp expression from the text in STRING. It returns a cons cell whose CAR is that expression, and whose CDR is an integer giving the position of the next remaining character in the string (i.e., the first one not read). If START is supplied, then reading begins at index START in the string (where the first character is at index 0). If you specify END, then reading is forced to stop just before that index, as if the rest of the string were not there. For example: (read-from-string "(setq x 55) (setq y 5)") => ((setq x 55) . 11) (read-from-string "\"A short string\"") => ("A short string" . 16) ;; Read starting at the first character. (read-from-string "(list 112)" 0) => ((list 112) . 10) ;; Read starting at the second character. (read-from-string "(list 112)" 1) => (list . 5) ;; Read starting at the seventh character, ;; and stopping at the ninth. (read-from-string "(list 112)" 6 8) => (11 . 8) - Variable: standard-input This variable holds the default input stream--the stream that `read' uses when the STREAM argument is `nil'. Output Streams ============== An output stream specifies what to do with the characters produced by printing. Most print functions accept an output stream as an optional argument. Here are the possible types of output stream: BUFFER The output characters are inserted into BUFFER at point. Point advances as characters are inserted. MARKER The output characters are inserted into the buffer that MARKER points into, at the marker position. The marker position advances as characters are inserted. The value of point in the buffer has no effect on printing when the stream is a marker, and this kind of printing does not move point. FUNCTION The output characters are passed to FUNCTION, which is responsible for storing them away. It is called with a single character as argument, as many times as there are characters to be output, and is responsible for storing the characters wherever you want to put them. `t' The output characters are displayed in the echo area. `nil' `nil' specified as an output stream means to use the value of `standard-output' instead; that value is the "default output stream", and must not be `nil'. SYMBOL A symbol as output stream is equivalent to the symbol's function definition (if any). Many of the valid output streams are also valid as input streams. The difference between input and output streams is therefore more a matter of how you use a Lisp object, than of different types of object. Here is an example of a buffer used as an output stream. Point is initially located as shown immediately before the `h' in `the'. At the end, point is located directly before that same `h'. ---------- Buffer: foo ---------- This is t-!-he contents of foo. ---------- Buffer: foo ---------- (print "This is the output" (get-buffer "foo")) => "This is the output" ---------- Buffer: foo ---------- This is t "This is the output" -!-he contents of foo. ---------- Buffer: foo ---------- Now we show a use of a marker as an output stream. Initially, the marker is in buffer `foo', between the `t' and the `h' in the word `the'. At the end, the marker has advanced over the inserted text so that it remains positioned before the same `h'. Note that the location of point, shown in the usual fashion, has no effect. ---------- Buffer: foo ---------- This is the -!-output ---------- Buffer: foo ---------- (setq m (copy-marker 10)) => # (print "More output for foo." m) => "More output for foo." ---------- Buffer: foo ---------- This is t "More output for foo." he -!-output ---------- Buffer: foo ---------- m => # The following example shows output to the echo area: (print "Echo Area output" t) => "Echo Area output" ---------- Echo Area ---------- "Echo Area output" ---------- Echo Area ---------- Finally, we show the use of a function as an output stream. The function `eat-output' takes each character that it is given and conses it onto the front of the list `last-output' (*note Building Lists::.). At the end, the list contains all the characters output, but in reverse order. (setq last-output nil) => nil (defun eat-output (c) (setq last-output (cons c last-output))) => eat-output (print "This is the output" 'eat-output) => "This is the output" last-output => (10 34 116 117 112 116 117 111 32 101 104 116 32 115 105 32 115 105 104 84 34 10) Now we can put the output in the proper order by reversing the list: (concat (nreverse last-output)) => " \"This is the output\" " Calling `concat' converts the list to a string so you can see its contents more clearly. Output Functions ================ This section describes the Lisp functions for printing Lisp objects--converting objects into their printed representation. Some of the Emacs printing functions add quoting characters to the output when necessary so that it can be read properly. The quoting characters used are `"' and `\'; they distinguish strings from symbols, and prevent punctuation characters in strings and symbols from being taken as delimiters when reading. *Note Printed Representation::, for full details. You specify quoting or no quoting by the choice of printing function. If the text is to be read back into Lisp, then you should print with quoting characters to avoid ambiguity. Likewise, if the purpose is to describe a Lisp object clearly for a Lisp programmer. However, if the purpose of the output is to look nice for humans, then it is usually better to print without quoting. Lisp objects can refer to themselves. Printing a self-referential object in the normal way would require an infinite amount of text, and the attempt could cause infinite recursion. Emacs detects such recursion and prints `#LEVEL' instead of recursively printing an object already being printed. For example, here `#0' indicates a recursive reference to the object at level 0 of the current print operation: (setq foo (list nil)) => (nil) (setcar foo foo) => (#0) In the functions below, STREAM stands for an output stream. (See the previous section for a description of output streams.) If STREAM is `nil' or omitted, it defaults to the value of `standard-output'. - Function: print OBJECT &optional STREAM The `print' function is a convenient way of printing. It outputs the printed representation of OBJECT to STREAM, printing in addition one newline before OBJECT and another after it. Quoting characters are used. `print' returns OBJECT. For example: (progn (print 'The\ cat\ in) (print "the hat") (print " came back")) -| -| The\ cat\ in -| -| "the hat" -| -| " came back" -| => " came back" - Function: prin1 OBJECT &optional STREAM This function outputs the printed representation of OBJECT to STREAM. It does not print newlines to separate output as `print' does, but it does use quoting characters just like `print'. It returns OBJECT. (progn (prin1 'The\ cat\ in) (prin1 "the hat") (prin1 " came back")) -| The\ cat\ in"the hat"" came back" => " came back" - Function: princ OBJECT &optional STREAM This function outputs the printed representation of OBJECT to STREAM. It returns OBJECT. This function is intended to produce output that is readable by people, not by `read', so it doesn't insert quoting characters and doesn't put double-quotes around the contents of strings. It does not add any spacing between calls. (progn (princ 'The\ cat) (princ " in the \"hat\"")) -| The cat in the "hat" => " in the \"hat\"" - Function: terpri &optional STREAM This function outputs a newline to STREAM. The name stands for "terminate print". - Function: write-char CHARACTER &optional STREAM This function outputs CHARACTER to STREAM. It returns CHARACTER. - Function: prin1-to-string OBJECT &optional NOESCAPE This function returns a string containing the text that `prin1' would have printed for the same argument. (prin1-to-string 'foo) => "foo" (prin1-to-string (mark-marker)) => "#" If NOESCAPE is non-`nil', that inhibits use of quoting characters in the output. (This argument is supported in Emacs versions 19 and later.) (prin1-to-string "foo") => "\"foo\"" (prin1-to-string "foo" t) => "foo" See `format', in *Note String Conversion::, for other ways to obtain the printed representation of a Lisp object as a string. - Macro: with-output-to-string BODY... This macro executes the BODY forms with `standard-output' set up to feed output into a string. Then it returns that string. For example, if the current buffer name is `foo', (with-output-to-string (princ "The buffer is ") (princ (buffer-name))) returns `"The buffer is foo"'. Variables Affecting Output ========================== - Variable: standard-output The value of this variable is the default output stream--the stream that print functions use when the STREAM argument is `nil'. - Variable: print-escape-newlines If this variable is non-`nil', then newline characters in strings are printed as `\n' and formfeeds are printed as `\f'. Normally these characters are printed as actual newlines and formfeeds. This variable affects the print functions `prin1' and `print' that print with quoting. It does not affect `princ'. Here is an example using `prin1': (prin1 "a\nb") -| "a -| b" => "a b" (let ((print-escape-newlines t)) (prin1 "a\nb")) -| "a\nb" => "a b" In the second expression, the local binding of `print-escape-newlines' is in effect during the call to `prin1', but not during the printing of the result. - Variable: print-escape-nonascii If this variable is non-`nil', then unibyte non-ASCII characters in strings are unconditionally printed as backslash sequences by the print functions `prin1' and `print' that print with quoting. Those functions also use backslash sequences for unibyte non-ASCII characters, regardless of the value of this variable, when the output stream is a multibyte buffer or a marker pointing into one. - Variable: print-escape-multibyte If this variable is non-`nil', then multibyte non-ASCII characters in strings are unconditionally printed as backslash sequences by the print functions `prin1' and `print' that print with quoting. Those functions also use backslash sequences for multibyte non-ASCII characters, regardless of the value of this variable, when the output stream is a unibyte buffer or a marker pointing into one. - Variable: print-length The value of this variable is the maximum number of elements to print in any list, vector or bool-vector. If an object being printed has more than this many elements, it is abbreviated with an ellipsis. If the value is `nil' (the default), then there is no limit. (setq print-length 2) => 2 (print '(1 2 3 4 5)) -| (1 2 ...) => (1 2 ...) - Variable: print-level The value of this variable is the maximum depth of nesting of parentheses and brackets when printed. Any list or vector at a depth exceeding this limit is abbreviated with an ellipsis. A value of `nil' (which is the default) means no limit. Minibuffers *********** A "minibuffer" is a special buffer that Emacs commands use to read arguments more complicated than the single numeric prefix argument. These arguments include file names, buffer names, and command names (as in `M-x'). The minibuffer is displayed on the bottom line of the frame, in the same place as the echo area, but only while it is in use for reading an argument. Introduction to Minibuffers =========================== In most ways, a minibuffer is a normal Emacs buffer. Most operations *within* a buffer, such as editing commands, work normally in a minibuffer. However, many operations for managing buffers do not apply to minibuffers. The name of a minibuffer always has the form ` *Minibuf-NUMBER', and it cannot be changed. Minibuffers are displayed only in special windows used only for minibuffers; these windows always appear at the bottom of a frame. (Sometimes frames have no minibuffer window, and sometimes a special kind of frame contains nothing but a minibuffer window; see *Note Minibuffers and Frames::.) The minibuffer's window is normally a single line. You can resize it temporarily with the window sizing commands; it reverts to its normal size when the minibuffer is exited. You can resize it permanently by using the window sizing commands in the frame's other window, when the minibuffer is not active. If the frame contains just a minibuffer, you can change the minibuffer's size by changing the frame's size. If a command uses a minibuffer while there is an active minibuffer, this is called a "recursive minibuffer". The first minibuffer is named ` *Minibuf-0*'. Recursive minibuffers are named by incrementing the number at the end of the name. (The names begin with a space so that they won't show up in normal buffer lists.) Of several recursive minibuffers, the innermost (or most recently entered) is the active minibuffer. We usually call this "the" minibuffer. You can permit or forbid recursive minibuffers by setting the variable `enable-recursive-minibuffers' or by putting properties of that name on command symbols (*note Minibuffer Misc::.). Like other buffers, a minibuffer may use any of several local keymaps (*note Keymaps::.); these contain various exit commands and in some cases completion commands (*note Completion::.). * `minibuffer-local-map' is for ordinary input (no completion). * `minibuffer-local-ns-map' is similar, except that exits just like . This is used mainly for Mocklisp compatibility. * `minibuffer-local-completion-map' is for permissive completion. * `minibuffer-local-must-match-map' is for strict completion and for cautious completion. Reading Text Strings with the Minibuffer ======================================== Most often, the minibuffer is used to read text as a string. It can also be used to read a Lisp object in textual form. The most basic primitive for minibuffer input is `read-from-minibuffer'; it can do either one. In most cases, you should not call minibuffer input functions in the middle of a Lisp function. Instead, do all minibuffer input as part of reading the arguments for a command, in the `interactive' specification. *Note Defining Commands::. - Function: read-from-minibuffer PROMPT-STRING &optional INITIAL-CONTENTS KEYMAP READ HIST DEFAULT INHERIT-INPUT-METHOD This function is the most general way to get input through the minibuffer. By default, it accepts arbitrary text and returns it as a string; however, if READ is non-`nil', then it uses `read' to convert the text into a Lisp object (*note Input Functions::.). The first thing this function does is to activate a minibuffer and display it with PROMPT-STRING as the prompt. This value must be a string. Then the user can edit text in the minibuffer. When the user types a command to exit the minibuffer, `read-from-minibuffer' constructs the return value from the text in the minibuffer. Normally it returns a string containing that text. However, if READ is non-`nil', `read-from-minibuffer' reads the text and returns the resulting Lisp object, unevaluated. (*Note Input Functions::, for information about reading.) The argument DEFAULT specifies a default value to make available through the history commands. It should be a string, or `nil'. If READ is non-`nil', then DEFAULT is also used as the input to `read', if the user enters empty input. However, in the usual case (where READ is `nil'), `read-from-minibuffer' does not return DEFAULT when the user enters empty input; it returns an empty string, `""'. In this respect, it is different from all the other minibuffer input functions in this chapter. If KEYMAP is non-`nil', that keymap is the local keymap to use in the minibuffer. If KEYMAP is omitted or `nil', the value of `minibuffer-local-map' is used as the keymap. Specifying a keymap is the most important way to customize the minibuffer for various applications such as completion. The argument HIST specifies which history list variable to use for saving the input and for history commands used in the minibuffer. It defaults to `minibuffer-history'. *Note Minibuffer History::. If the variable `minibuffer-allow-text-properties' is non-`nil', then the string which is returned includes whatever text properties were present in the minibuffer. Otherwise all the text properties are stripped when the value is returned. If the argument INHERIT-INPUT-METHOD is non-`nil', then the minibuffer inherits the current input method (*note Input Methods::.) and the setting of `enable-multibyte-characters' (*note Text Representations::.) from whichever buffer was current before entering the minibuffer. If INITIAL-CONTENTS is a string, `read-from-minibuffer' inserts it into the minibuffer, leaving point at the end, before the user starts to edit the text. The minibuffer appears with this text as its initial contents. Alternatively, INITIAL-CONTENTS can be a cons cell of the form `(STRING . POSITION)'. This means to insert STRING in the minibuffer but put point POSITION characters from the beginning, rather than at the end. *Usage note:* The INITIAL-CONTENTS argument and the DEFAULT argument are two alternative features for more or less the same job. It does not make sense to use both features in a single call to `read-from-minibuffer'. In general, we recommend using DEFAULT, since this permits the user to insert the default value when it is wanted, but does not burden the user with deleting it from the minibuffer on other occasions. - Function: read-string PROMPT &optional INITIAL HISTORY DEFAULT INHERIT-INPUT-METHOD This function reads a string from the minibuffer and returns it. The arguments PROMPT and INITIAL are used as in `read-from-minibuffer'. The keymap used is `minibuffer-local-map'. The optional argument HISTORY, if non-nil, specifies a history list and optionally the initial position in the list. The optional argument DEFAULT specifies a default value to return if the user enters null input; it should be a string. The optional argument INHERIT-INPUT-METHOD specifies whether to inherit the current buffer's input method. This function is a simplified interface to the `read-from-minibuffer' function: (read-string PROMPT INITIAL HISTORY DEFAULT INHERIT) == (let ((value (read-from-minibuffer PROMPT INITIAL nil nil HISTORY DEFAULT INHERIT))) (if (equal value "") DEFAULT value)) - Variable: minibuffer-allow-text-properties If this variable is `nil', then `read-from-minibuffer' strips all text properties from the minibuffer input before returning it. Since all minibuffer input uses `read-from-minibuffer', this variable applies to all minibuffer input. Note that the completion functions discard text properties unconditionally, regardless of the value of this variable. - Variable: minibuffer-local-map This is the default local keymap for reading from the minibuffer. By default, it makes the following bindings: `C-j' `exit-minibuffer' `exit-minibuffer' `C-g' `abort-recursive-edit' `M-n' `next-history-element' `M-p' `previous-history-element' `M-r' `next-matching-history-element' `M-s' `previous-matching-history-element' - Function: read-no-blanks-input PROMPT &optional INITIAL INHERIT-INPUT-METHOD This function reads a string from the minibuffer, but does not allow whitespace characters as part of the input: instead, those characters terminate the input. The arguments PROMPT, INITIAL, and INHERIT-INPUT-METHOD are used as in `read-from-minibuffer'. This is a simplified interface to the `read-from-minibuffer' function, and passes the value of the `minibuffer-local-ns-map' keymap as the KEYMAP argument for that function. Since the keymap `minibuffer-local-ns-map' does not rebind `C-q', it *is* possible to put a space into the string, by quoting it. (read-no-blanks-input PROMPT INITIAL) == (read-from-minibuffer PROMPT INITIAL minibuffer-local-ns-map) - Variable: minibuffer-local-ns-map This built-in variable is the keymap used as the minibuffer local keymap in the function `read-no-blanks-input'. By default, it makes the following bindings, in addition to those of `minibuffer-local-map': `exit-minibuffer' `exit-minibuffer' `?' `self-insert-and-exit' Reading Lisp Objects with the Minibuffer ======================================== This section describes functions for reading Lisp objects with the minibuffer. - Function: read-minibuffer PROMPT &optional INITIAL This function reads a Lisp object using the minibuffer, and returns it without evaluating it. The arguments PROMPT and INITIAL are used as in `read-from-minibuffer'. This is a simplified interface to the `read-from-minibuffer' function: (read-minibuffer PROMPT INITIAL) == (read-from-minibuffer PROMPT INITIAL nil t) Here is an example in which we supply the string `"(testing)"' as initial input: (read-minibuffer "Enter an expression: " (format "%s" '(testing))) ;; Here is how the minibuffer is displayed: ---------- Buffer: Minibuffer ---------- Enter an expression: (testing)-!- ---------- Buffer: Minibuffer ---------- The user can type immediately to use the initial input as a default, or can edit the input. - Function: eval-minibuffer PROMPT &optional INITIAL This function reads a Lisp expression using the minibuffer, evaluates it, then returns the result. The arguments PROMPT and INITIAL are used as in `read-from-minibuffer'. This function simply evaluates the result of a call to `read-minibuffer': (eval-minibuffer PROMPT INITIAL) == (eval (read-minibuffer PROMPT INITIAL)) - Function: edit-and-eval-command PROMPT FORM This function reads a Lisp expression in the minibuffer, and then evaluates it. The difference between this command and `eval-minibuffer' is that here the initial FORM is not optional and it is treated as a Lisp object to be converted to printed representation rather than as a string of text. It is printed with `prin1', so if it is a string, double-quote characters (`"') appear in the initial text. *Note Output Functions::. The first thing `edit-and-eval-command' does is to activate the minibuffer with PROMPT as the prompt. Then it inserts the printed representation of FORM in the minibuffer, and lets the user edit it. When the user exits the minibuffer, the edited text is read with `read' and then evaluated. The resulting value becomes the value of `edit-and-eval-command'. In the following example, we offer the user an expression with initial text which is a valid form already: (edit-and-eval-command "Please edit: " '(forward-word 1)) ;; After evaluation of the preceding expression, ;; the following appears in the minibuffer: ---------- Buffer: Minibuffer ---------- Please edit: (forward-word 1)-!- ---------- Buffer: Minibuffer ---------- Typing right away would exit the minibuffer and evaluate the expression, thus moving point forward one word. `edit-and-eval-command' returns `nil' in this example. Minibuffer History ================== A "minibuffer history list" records previous minibuffer inputs so the user can reuse them conveniently. A history list is actually a symbol, not a list; it is a variable whose value is a list of strings (previous inputs), most recent first. There are many separate history lists, used for different kinds of inputs. It's the Lisp programmer's job to specify the right history list for each use of the minibuffer. The basic minibuffer input functions `read-from-minibuffer' and `completing-read' both accept an optional argument named HIST which is how you specify the history list. Here are the possible values: VARIABLE Use VARIABLE (a symbol) as the history list. (VARIABLE . STARTPOS) Use VARIABLE (a symbol) as the history list, and assume that the initial history position is STARTPOS (an integer, counting from zero which specifies the most recent element of the history). If you specify STARTPOS, then you should also specify that element of the history as the initial minibuffer contents, for consistency. If you don't specify HIST, then the default history list `minibuffer-history' is used. For other standard history lists, see below. You can also create your own history list variable; just initialize it to `nil' before the first use. Both `read-from-minibuffer' and `completing-read' add new elements to the history list automatically, and provide commands to allow the user to reuse items on the list. The only thing your program needs to do to use a history list is to initialize it and to pass its name to the input functions when you wish. But it is safe to modify the list by hand when the minibuffer input functions are not using it. Here are some of the standard minibuffer history list variables: - Variable: minibuffer-history The default history list for minibuffer history input. - Variable: query-replace-history A history list for arguments to `query-replace' (and similar arguments to other commands). - Variable: file-name-history A history list for file-name arguments. - Variable: buffer-name-history A history list for buffer-name arguments. - Variable: regexp-history A history list for regular expression arguments. - Variable: extended-command-history A history list for arguments that are names of extended commands. - Variable: shell-command-history A history list for arguments that are shell commands. - Variable: read-expression-history A history list for arguments that are Lisp expressions to evaluate. Completion ========== "Completion" is a feature that fills in the rest of a name starting from an abbreviation for it. Completion works by comparing the user's input against a list of valid names and determining how much of the name is determined uniquely by what the user has typed. For example, when you type `C-x b' (`switch-to-buffer') and then type the first few letters of the name of the buffer to which you wish to switch, and then type (`minibuffer-complete'), Emacs extends the name as far as it can. Standard Emacs commands offer completion for names of symbols, files, buffers, and processes; with the functions in this section, you can implement completion for other kinds of names. The `try-completion' function is the basic primitive for completion: it returns the longest determined completion of a given initial string, with a given set of strings to match against. The function `completing-read' provides a higher-level interface for completion. A call to `completing-read' specifies how to determine the list of valid names. The function then activates the minibuffer with a local keymap that binds a few keys to commands useful for completion. Other functions provide convenient simple interfaces for reading certain kinds of names with completion. Basic Completion Functions -------------------------- The two functions `try-completion' and `all-completions' have nothing in themselves to do with minibuffers. We describe them in this chapter so as to keep them near the higher-level completion features that do use the minibuffer. - Function: try-completion STRING COLLECTION &optional PREDICATE This function returns the longest common substring of all possible completions of STRING in COLLECTION. The value of COLLECTION must be an alist, an obarray, or a function that implements a virtual set of strings (see below). Completion compares STRING against each of the permissible completions specified by COLLECTION; if the beginning of the permissible completion equals STRING, it matches. If no permissible completions match, `try-completion' returns `nil'. If only one permissible completion matches, and the match is exact, then `try-completion' returns `t'. Otherwise, the value is the longest initial sequence common to all the permissible completions that match. If COLLECTION is an alist (*note Association Lists::.), the CARs of the alist elements form the set of permissible completions. If COLLECTION is an obarray (*note Creating Symbols::.), the names of all symbols in the obarray form the set of permissible completions. The global variable `obarray' holds an obarray containing the names of all interned Lisp symbols. Note that the only valid way to make a new obarray is to create it empty and then add symbols to it one by one using `intern'. Also, you cannot intern a given symbol in more than one obarray. If the argument PREDICATE is non-`nil', then it must be a function of one argument. It is used to test each possible match, and the match is accepted only if PREDICATE returns non-`nil'. The argument given to PREDICATE is either a cons cell from the alist (the CAR of which is a string) or else it is a symbol (*not* a symbol name) from the obarray. You can also use a symbol that is a function as COLLECTION. Then the function is solely responsible for performing completion; `try-completion' returns whatever this function returns. The function is called with three arguments: STRING, PREDICATE and `nil'. (The reason for the third argument is so that the same function can be used in `all-completions' and do the appropriate thing in either case.) *Note Programmed Completion::. In the first of the following examples, the string `foo' is matched by three of the alist CARs. All of the matches begin with the characters `fooba', so that is the result. In the second example, there is only one possible match, and it is exact, so the value is `t'. (try-completion "foo" '(("foobar1" 1) ("barfoo" 2) ("foobaz" 3) ("foobar2" 4))) => "fooba" (try-completion "foo" '(("barfoo" 2) ("foo" 3))) => t In the following example, numerous symbols begin with the characters `forw', and all of them begin with the word `forward'. In most of the symbols, this is followed with a `-', but not in all, so no more than `forward' can be completed. (try-completion "forw" obarray) => "forward" Finally, in the following example, only two of the three possible matches pass the predicate `test' (the string `foobaz' is too short). Both of those begin with the string `foobar'. (defun test (s) (> (length (car s)) 6)) => test (try-completion "foo" '(("foobar1" 1) ("barfoo" 2) ("foobaz" 3) ("foobar2" 4)) 'test) => "foobar" - Function: all-completions STRING COLLECTION &optional PREDICATE NOSPACE This function returns a list of all possible completions of STRING. The arguments to this function are the same as those of `try-completion'. If COLLECTION is a function, it is called with three arguments: STRING, PREDICATE and `t'; then `all-completions' returns whatever the function returns. *Note Programmed Completion::. If NOSPACE is non-`nil', completions that start with a space are ignored unless STRING also starts with a space. Here is an example, using the function `test' shown in the example for `try-completion': (defun test (s) (> (length (car s)) 6)) => test (all-completions "foo" '(("foobar1" 1) ("barfoo" 2) ("foobaz" 3) ("foobar2" 4)) 'test) => ("foobar1" "foobar2") - Variable: completion-ignore-case If the value of this variable is non-`nil', Emacs does not consider case significant in completion. Completion and the Minibuffer ----------------------------- This section describes the basic interface for reading from the minibuffer with completion. - Function: completing-read PROMPT COLLECTION &optional PREDICATE REQUIRE-MATCH INITIAL HIST DEFAULT INHERIT-INPUT-METHOD This function reads a string in the minibuffer, assisting the user by providing completion. It activates the minibuffer with prompt PROMPT, which must be a string. The actual completion is done by passing COLLECTION and PREDICATE to the function `try-completion'. This happens in certain commands bound in the local keymaps used for completion. If REQUIRE-MATCH is `nil', the exit commands work regardless of the input in the minibuffer. If REQUIRE-MATCH is `t', the usual minibuffer exit commands won't exit unless the input completes to an element of COLLECTION. If REQUIRE-MATCH is neither `nil' nor `t', then the exit commands won't exit unless the input already in the buffer matches an element of COLLECTION. However, empty input is always permitted, regardless of the value of REQUIRE-MATCH; in that case, `completing-read' returns DEFAULT. The value of DEFAULT (if non-`nil') is also available to the user through the history commands. The user can exit with null input by typing with an empty minibuffer. Then `completing-read' returns `""'. This is how the user requests whatever default the command uses for the value being read. The user can return using in this way regardless of the value of REQUIRE-MATCH, and regardless of whether the empty string is included in COLLECTION. The function `completing-read' works by calling `read-minibuffer'. It uses `minibuffer-local-completion-map' as the keymap if REQUIRE-MATCH is `nil', and uses `minibuffer-local-must-match-map' if REQUIRE-MATCH is non-`nil'. *Note Completion Commands::. The argument HIST specifies which history list variable to use for saving the input and for minibuffer history commands. It defaults to `minibuffer-history'. *Note Minibuffer History::. If INITIAL is non-`nil', `completing-read' inserts it into the minibuffer as part of the input. Then it allows the user to edit the input, providing several commands to attempt completion. In most cases, we recommend using DEFAULT, and not INITIAL. If the argument INHERIT-INPUT-METHOD is non-`nil', then the minibuffer inherits the current input method (*note Input Methods::.) and the setting of `enable-multibyte-characters' (*note Text Representations::.) from whichever buffer was current before entering the minibuffer. Completion ignores case when comparing the input against the possible matches, if the built-in variable `completion-ignore-case' is non-`nil'. *Note Basic Completion::. Here's an example of using `completing-read': (completing-read "Complete a foo: " '(("foobar1" 1) ("barfoo" 2) ("foobaz" 3) ("foobar2" 4)) nil t "fo") ;; After evaluation of the preceding expression, ;; the following appears in the minibuffer: ---------- Buffer: Minibuffer ---------- Complete a foo: fo-!- ---------- Buffer: Minibuffer ---------- If the user then types ` b ', `completing-read' returns `barfoo'. The `completing-read' function binds three variables to pass information to the commands that actually do completion. These variables are `minibuffer-completion-table', `minibuffer-completion-predicate' and `minibuffer-completion-confirm'. For more information about them, see *Note Completion Commands::. Minibuffer Commands That Do Completion -------------------------------------- This section describes the keymaps, commands and user options used in the minibuffer to do completion. - Variable: minibuffer-local-completion-map `completing-read' uses this value as the local keymap when an exact match of one of the completions is not required. By default, this keymap makes the following bindings: `?' `minibuffer-completion-help' `minibuffer-complete-word' `minibuffer-complete' with other characters bound as in `minibuffer-local-map' (*note Text from Minibuffer::.). - Variable: minibuffer-local-must-match-map `completing-read' uses this value as the local keymap when an exact match of one of the completions is required. Therefore, no keys are bound to `exit-minibuffer', the command that exits the minibuffer unconditionally. By default, this keymap makes the following bindings: `?' `minibuffer-completion-help' `minibuffer-complete-word' `minibuffer-complete' `C-j' `minibuffer-complete-and-exit' `minibuffer-complete-and-exit' with other characters bound as in `minibuffer-local-map'. - Variable: minibuffer-completion-table The value of this variable is the alist or obarray used for completion in the minibuffer. This is the global variable that contains what `completing-read' passes to `try-completion'. It is used by minibuffer completion commands such as `minibuffer-complete-word'. - Variable: minibuffer-completion-predicate This variable's value is the predicate that `completing-read' passes to `try-completion'. The variable is also used by the other minibuffer completion functions. - Command: minibuffer-complete-word This function completes the minibuffer contents by at most a single word. Even if the minibuffer contents have only one completion, `minibuffer-complete-word' does not add any characters beyond the first character that is not a word constituent. *Note Syntax Tables::. - Command: minibuffer-complete This function completes the minibuffer contents as far as possible. - Command: minibuffer-complete-and-exit This function completes the minibuffer contents, and exits if confirmation is not required, i.e., if `minibuffer-completion-confirm' is `nil'. If confirmation *is* required, it is given by repeating this command immediately--the command is programmed to work without confirmation when run twice in succession. - Variable: minibuffer-completion-confirm When the value of this variable is non-`nil', Emacs asks for confirmation of a completion before exiting the minibuffer. The function `minibuffer-complete-and-exit' checks the value of this variable before it exits. - Command: minibuffer-completion-help This function creates a list of the possible completions of the current minibuffer contents. It works by calling `all-completions' using the value of the variable `minibuffer-completion-table' as the COLLECTION argument, and the value of `minibuffer-completion-predicate' as the PREDICATE argument. The list of completions is displayed as text in a buffer named `*Completions*'. - Function: display-completion-list COMPLETIONS This function displays COMPLETIONS to the stream in `standard-output', usually a buffer. (*Note Read and Print::, for more information about streams.) The argument COMPLETIONS is normally a list of completions just returned by `all-completions', but it does not have to be. Each element may be a symbol or a string, either of which is simply printed, or a list of two strings, which is printed as if the strings were concatenated. This function is called by `minibuffer-completion-help'. The most common way to use it is together with `with-output-to-temp-buffer', like this: (with-output-to-temp-buffer "*Completions*" (display-completion-list (all-completions (buffer-string) my-alist))) - User Option: completion-auto-help If this variable is non-`nil', the completion commands automatically display a list of possible completions whenever nothing can be completed because the next character is not uniquely determined. High-Level Completion Functions -------------------------------- This section describes the higher-level convenient functions for reading certain sorts of names with completion. In most cases, you should not call these functions in the middle of a Lisp function. When possible, do all minibuffer input as part of reading the arguments for a command, in the `interactive' specification. *Note Defining Commands::. - Function: read-buffer PROMPT &optional DEFAULT EXISTING This function reads the name of a buffer and returns it as a string. The argument DEFAULT is the default name to use, the value to return if the user exits with an empty minibuffer. If non-`nil', it should be a string or a buffer. It is mentioned in the prompt, but is not inserted in the minibuffer as initial input. If EXISTING is non-`nil', then the name specified must be that of an existing buffer. The usual commands to exit the minibuffer do not exit if the text is not valid, and does completion to attempt to find a valid name. (However, DEFAULT is not checked for validity; it is returned, whatever it is, if the user exits with the minibuffer empty.) In the following example, the user enters `minibuffer.t', and then types . The argument EXISTING is `t', and the only buffer name starting with the given input is `minibuffer.texi', so that name is the value. (read-buffer "Buffer name? " "foo" t) ;; After evaluation of the preceding expression, ;; the following prompt appears, ;; with an empty minibuffer: ---------- Buffer: Minibuffer ---------- Buffer name? (default foo) -!- ---------- Buffer: Minibuffer ---------- ;; The user types `minibuffer.t '. => "minibuffer.texi" - Variable: read-buffer-function This variable specifies how to read buffer names. For example, if you set this variable to `iswitchb-read-buffer', all Emacs commands that call `read-buffer' to read a buffer name will actually use the `iswitchb' package to read it. - Function: read-command PROMPT &optional DEFAULT This function reads the name of a command and returns it as a Lisp symbol. The argument PROMPT is used as in `read-from-minibuffer'. Recall that a command is anything for which `commandp' returns `t', and a command name is a symbol for which `commandp' returns `t'. *Note Interactive Call::. The argument DEFAULT specifies what to return if the user enters null input. It can be a symbol or a string; if it is a string, `read-command' interns it before returning it. If DEFAULT is `nil', that means no default has been specified; then if the user enters null input, the return value is `nil'. (read-command "Command name? ") ;; After evaluation of the preceding expression, ;; the following prompt appears with an empty minibuffer: ---------- Buffer: Minibuffer ---------- Command name? ---------- Buffer: Minibuffer ---------- If the user types `forward-c ', then this function returns `forward-char'. The `read-command' function is a simplified interface to `completing-read'. It uses the variable `obarray' so as to complete in the set of extant Lisp symbols, and it uses the `commandp' predicate so as to accept only command names: (read-command PROMPT) == (intern (completing-read PROMPT obarray 'commandp t nil)) - Function: read-variable PROMPT &optional DEFAULT This function reads the name of a user variable and returns it as a symbol. The argument DEFAULT specifies what to return if the user enters null input. It can be a symbol or a string; if it is a string, `read-variable' interns it before returning it. If DEFAULT is `nil', that means no default has been specified; then if the user enters null input, the return value is `nil'. (read-variable "Variable name? ") ;; After evaluation of the preceding expression, ;; the following prompt appears, ;; with an empty minibuffer: ---------- Buffer: Minibuffer ---------- Variable name? -!- ---------- Buffer: Minibuffer ---------- If the user then types `fill-p ', `read-variable' returns `fill-prefix'. This function is similar to `read-command', but uses the predicate `user-variable-p' instead of `commandp': (read-variable PROMPT) == (intern (completing-read PROMPT obarray 'user-variable-p t nil)) See also the functions `read-coding-system' and `read-non-nil-coding-system', in *Note User-Chosen Coding Systems::. Reading File Names ------------------ Here is another high-level completion function, designed for reading a file name. It provides special features including automatic insertion of the default directory. - Function: read-file-name PROMPT &optional DIRECTORY DEFAULT EXISTING INITIAL This function reads a file name in the minibuffer, prompting with PROMPT and providing completion. If DEFAULT is non-`nil', then the function returns DEFAULT if the user just types . DEFAULT is not checked for validity; it is returned, whatever it is, if the user exits with the minibuffer empty. If EXISTING is non-`nil', then the user must specify the name of an existing file; performs completion to make the name valid if possible, and then refuses to exit if it is not valid. If the value of EXISTING is neither `nil' nor `t', then also requires confirmation after completion. If EXISTING is `nil', then the name of a nonexistent file is acceptable. The argument DIRECTORY specifies the directory to use for completion of relative file names. If `insert-default-directory' is non-`nil', DIRECTORY is also inserted in the minibuffer as initial input. It defaults to the current buffer's value of `default-directory'. If you specify INITIAL, that is an initial file name to insert in the buffer (after DIRECTORY, if that is inserted). In this case, point goes at the beginning of INITIAL. The default for INITIAL is `nil'--don't insert any file name. To see what INITIAL does, try the command `C-x C-v'. *Note:* we recommend using DEFAULT rather than INITIAL in most cases. Here is an example: (read-file-name "The file is ") ;; After evaluation of the preceding expression, ;; the following appears in the minibuffer: ---------- Buffer: Minibuffer ---------- The file is /gp/gnu/elisp/-!- ---------- Buffer: Minibuffer ---------- Typing `manual ' results in the following: ---------- Buffer: Minibuffer ---------- The file is /gp/gnu/elisp/manual.texi-!- ---------- Buffer: Minibuffer ---------- If the user types , `read-file-name' returns the file name as the string `"/gp/gnu/elisp/manual.texi"'. - User Option: insert-default-directory This variable is used by `read-file-name'. Its value controls whether `read-file-name' starts by placing the name of the default directory in the minibuffer, plus the initial file name if any. If the value of this variable is `nil', then `read-file-name' does not place any initial input in the minibuffer (unless you specify initial input with the INITIAL argument). In that case, the default directory is still used for completion of relative file names, but is not displayed. For example: ;; Here the minibuffer starts out with the default directory. (let ((insert-default-directory t)) (read-file-name "The file is ")) ---------- Buffer: Minibuffer ---------- The file is ~lewis/manual/-!- ---------- Buffer: Minibuffer ---------- ;; Here the minibuffer is empty and only the prompt ;; appears on its line. (let ((insert-default-directory nil)) (read-file-name "The file is ")) ---------- Buffer: Minibuffer ---------- The file is -!- ---------- Buffer: Minibuffer ---------- Programmed Completion --------------------- Sometimes it is not possible to create an alist or an obarray containing all the intended possible completions. In such a case, you can supply your own function to compute the completion of a given string. This is called "programmed completion". To use this feature, pass a symbol with a function definition as the COLLECTION argument to `completing-read'. The function `completing-read' arranges to pass your completion function along to `try-completion' and `all-completions', which will then let your function do all the work. The completion function should accept three arguments: * The string to be completed. * The predicate function to filter possible matches, or `nil' if none. Your function should call the predicate for each possible match, and ignore the possible match if the predicate returns `nil'. * A flag specifying the type of operation. There are three flag values for three operations: * `nil' specifies `try-completion'. The completion function should return the completion of the specified string, or `t' if the string is a unique and exact match already, or `nil' if the string matches no possibility. If the string is an exact match for one possibility, but also matches other longer possibilities, the function should return the string, not `t'. * `t' specifies `all-completions'. The completion function should return a list of all possible completions of the specified string. * `lambda' specifies a test for an exact match. The completion function should return `t' if the specified string is an exact match for some possibility; `nil' otherwise. It would be consistent and clean for completion functions to allow lambda expressions (lists that are functions) as well as function symbols as COLLECTION, but this is impossible. Lists as completion tables are already assigned another meaning--as alists. It would be unreliable to fail to handle an alist normally because it is also a possible function. So you must arrange for any function you wish to use for completion to be encapsulated in a symbol. Emacs uses programmed completion when completing file names. *Note File Name Completion::. Yes-or-No Queries ================= This section describes functions used to ask the user a yes-or-no question. The function `y-or-n-p' can be answered with a single character; it is useful for questions where an inadvertent wrong answer will not have serious consequences. `yes-or-no-p' is suitable for more momentous questions, since it requires three or four characters to answer. If either of these functions is called in a command that was invoked using the mouse--more precisely, if `last-nonmenu-event' (*note Command Loop Info::.) is either `nil' or a list--then it uses a dialog box or pop-up menu to ask the question. Otherwise, it uses keyboard input. You can force use of the mouse or use of keyboard input by binding `last-nonmenu-event' to a suitable value around the call. Strictly speaking, `yes-or-no-p' uses the minibuffer and `y-or-n-p' does not; but it seems best to describe them together. - Function: y-or-n-p PROMPT This function asks the user a question, expecting input in the echo area. It returns `t' if the user types `y', `nil' if the user types `n'. This function also accepts to mean yes and to mean no. It accepts `C-]' to mean "quit", like `C-g', because the question might look like a minibuffer and for that reason the user might try to use `C-]' to get out. The answer is a single character, with no needed to terminate it. Upper and lower case are equivalent. "Asking the question" means printing PROMPT in the echo area, followed by the string `(y or n) '. If the input is not one of the expected answers (`y', `n', `', `', or something that quits), the function responds `Please answer y or n.', and repeats the request. This function does not actually use the minibuffer, since it does not allow editing of the answer. It actually uses the echo area (*note The Echo Area::.), which uses the same screen space as the minibuffer. The cursor moves to the echo area while the question is being asked. The answers and their meanings, even `y' and `n', are not hardwired. The keymap `query-replace-map' specifies them. *Note Search and Replace::. In the following example, the user first types `q', which is invalid. At the next prompt the user types `y'. (y-or-n-p "Do you need a lift? ") ;; After evaluation of the preceding expression, ;; the following prompt appears in the echo area: ---------- Echo area ---------- Do you need a lift? (y or n) ---------- Echo area ---------- ;; If the user then types `q', the following appears: ---------- Echo area ---------- Please answer y or n. Do you need a lift? (y or n) ---------- Echo area ---------- ;; When the user types a valid answer, ;; it is displayed after the question: ---------- Echo area ---------- Do you need a lift? (y or n) y ---------- Echo area ---------- We show successive lines of echo area messages, but only one actually appears on the screen at a time. - Function: y-or-n-p-with-timeout PROMPT SECONDS DEFAULT-VALUE Like `y-or-n-p', except that if the user fails to answer within SECONDS seconds, this function stops waiting and returns DEFAULT-VALUE. It works by setting up a timer; see *Note Timers::. The argument SECONDS may be an integer or a floating point number. - Function: yes-or-no-p PROMPT This function asks the user a question, expecting input in the minibuffer. It returns `t' if the user enters `yes', `nil' if the user types `no'. The user must type to finalize the response. Upper and lower case are equivalent. `yes-or-no-p' starts by displaying PROMPT in the echo area, followed by `(yes or no) '. The user must type one of the expected responses; otherwise, the function responds `Please answer yes or no.', waits about two seconds and repeats the request. `yes-or-no-p' requires more work from the user than `y-or-n-p' and is appropriate for more crucial decisions. Here is an example: (yes-or-no-p "Do you really want to remove everything? ") ;; After evaluation of the preceding expression, ;; the following prompt appears, ;; with an empty minibuffer: ---------- Buffer: minibuffer ---------- Do you really want to remove everything? (yes or no) ---------- Buffer: minibuffer ---------- If the user first types `y ', which is invalid because this function demands the entire word `yes', it responds by displaying these prompts, with a brief pause between them: ---------- Buffer: minibuffer ---------- Please answer yes or no. Do you really want to remove everything? (yes or no) ---------- Buffer: minibuffer ---------- Asking Multiple Y-or-N Questions ================================ When you have a series of similar questions to ask, such as "Do you want to save this buffer" for each buffer in turn, you should use `map-y-or-n-p' to ask the collection of questions, rather than asking each question individually. This gives the user certain convenient facilities such as the ability to answer the whole series at once. - Function: map-y-or-n-p PROMPTER ACTOR LIST &optional HELP ACTION-ALIST This function asks the user a series of questions, reading a single-character answer in the echo area for each one. The value of LIST specifies the objects to ask questions about. It should be either a list of objects or a generator function. If it is a function, it should expect no arguments, and should return either the next object to ask about, or `nil' meaning stop asking questions. The argument PROMPTER specifies how to ask each question. If PROMPTER is a string, the question text is computed like this: (format PROMPTER OBJECT) where OBJECT is the next object to ask about (as obtained from LIST). If not a string, PROMPTER should be a function of one argument (the next object to ask about) and should return the question text. If the value is a string, that is the question to ask the user. The function can also return `t' meaning do act on this object (and don't ask the user), or `nil' meaning ignore this object (and don't ask the user). The argument ACTOR says how to act on the answers that the user gives. It should be a function of one argument, and it is called with each object that the user says yes for. Its argument is always an object obtained from LIST. If the argument HELP is given, it should be a list of this form: (SINGULAR PLURAL ACTION) where SINGULAR is a string containing a singular noun that describes the objects conceptually being acted on, PLURAL is the corresponding plural noun, and ACTION is a transitive verb describing what ACTOR does. If you don't specify HELP, the default is `("object" "objects" "act on")'. Each time a question is asked, the user may enter `y', `Y', or to act on that object; `n', `N', or to skip that object; `!' to act on all following objects; or `q' to exit (skip all following objects); `.' (period) to act on the current object and then exit; or `C-h' to get help. These are the same answers that `query-replace' accepts. The keymap `query-replace-map' defines their meaning for `map-y-or-n-p' as well as for `query-replace'; see *Note Search and Replace::. You can use ACTION-ALIST to specify additional possible answers and what they mean. It is an alist of elements of the form `(CHAR FUNCTION HELP)', each of which defines one additional answer. In this element, CHAR is a character (the answer); FUNCTION is a function of one argument (an object from LIST); HELP is a string. When the user responds with CHAR, `map-y-or-n-p' calls FUNCTION. If it returns non-`nil', the object is considered "acted upon", and `map-y-or-n-p' advances to the next object in LIST. If it returns `nil', the prompt is repeated for the same object. If `map-y-or-n-p' is called in a command that was invoked using the mouse--more precisely, if `last-nonmenu-event' (*note Command Loop Info::.) is either `nil' or a list--then it uses a dialog box or pop-up menu to ask the question. In this case, it does not use keyboard input or the echo area. You can force use of the mouse or use of keyboard input by binding `last-nonmenu-event' to a suitable value around the call. The return value of `map-y-or-n-p' is the number of objects acted on. Reading a Password ================== To read a password to pass to another program, you can use the function `read-passwd'. - Function: read-passwd PROMPT &optional CONFIRM DEFAULT This function reads a password, prompting with PROMPT. It does not echo the password as the user types it; instead, it echoes `.' for each character in the password. The optional argument CONFIRM, if non-`nil', says to read the password twice and insist it must be the same both times. If it isn't the same, the user has to type it over and over until the last two times match. The optional argument DEFAULT specifies the default password to return if the user enters empty input. If DEFAULT is `nil', then `read-passwd' returns the null string in that case. Minibuffer Miscellany ===================== This section describes some basic functions and variables related to minibuffers. - Command: exit-minibuffer This command exits the active minibuffer. It is normally bound to keys in minibuffer local keymaps. - Command: self-insert-and-exit This command exits the active minibuffer after inserting the last character typed on the keyboard (found in `last-command-char'; *note Command Loop Info::.). - Command: previous-history-element N This command replaces the minibuffer contents with the value of the Nth previous (older) history element. - Command: next-history-element N This command replaces the minibuffer contents with the value of the Nth more recent history element. - Command: previous-matching-history-element PATTERN This command replaces the minibuffer contents with the value of the previous (older) history element that matches PATTERN (a regular expression). - Command: next-matching-history-element PATTERN This command replaces the minibuffer contents with the value of the next (newer) history element that matches PATTERN (a regular expression). - Function: minibuffer-prompt This function returns the prompt string of the currently active minibuffer. If no minibuffer is active, it returns `nil'. - Function: minibuffer-prompt-width This function returns the display width of the prompt string of the currently active minibuffer. If no minibuffer is active, it returns 0. - Variable: minibuffer-setup-hook This is a normal hook that is run whenever the minibuffer is entered. *Note Hooks::. - Variable: minibuffer-exit-hook This is a normal hook that is run whenever the minibuffer is exited. *Note Hooks::. - Variable: minibuffer-help-form The current value of this variable is used to rebind `help-form' locally inside the minibuffer (*note Help Functions::.). - Function: active-minibuffer-window This function returns the currently active minibuffer window, or `nil' if none is currently active. - Function: minibuffer-window &optional FRAME This function returns the minibuffer window used for frame FRAME. If FRAME is `nil', that stands for the current frame. Note that the minibuffer window used by a frame need not be part of that frame--a frame that has no minibuffer of its own necessarily uses some other frame's minibuffer window. - Function: window-minibuffer-p WINDOW This function returns non-`nil' if WINDOW is a minibuffer window. It is not correct to determine whether a given window is a minibuffer by comparing it with the result of `(minibuffer-window)', because there can be more than one minibuffer window if there is more than one frame. - Function: minibuffer-window-active-p WINDOW This function returns non-`nil' if WINDOW, assumed to be a minibuffer window, is currently active. - Variable: minibuffer-scroll-window If the value of this variable is non-`nil', it should be a window object. When the function `scroll-other-window' is called in the minibuffer, it scrolls this window. Finally, some functions and variables deal with recursive minibuffers (*note Recursive Editing::.): - Function: minibuffer-depth This function returns the current depth of activations of the minibuffer, a nonnegative integer. If no minibuffers are active, it returns zero. - User Option: enable-recursive-minibuffers If this variable is non-`nil', you can invoke commands (such as `find-file') that use minibuffers even while the minibuffer window is active. Such invocation produces a recursive editing level for a new minibuffer. The outer-level minibuffer is invisible while you are editing the inner one. If this variable is `nil', you cannot invoke minibuffer commands when the minibuffer window is active, not even if you switch to another window to do it. If a command name has a property `enable-recursive-minibuffers' that is non-`nil', then the command can use the minibuffer to read arguments even if it is invoked from the minibuffer. The minibuffer command `next-matching-history-element' (normally `M-s' in the minibuffer) uses this feature. Command Loop ************ When you run Emacs, it enters the "editor command loop" almost immediately. This loop reads key sequences, executes their definitions, and displays the results. In this chapter, we describe how these things are done, and the subroutines that allow Lisp programs to do them. Command Loop Overview ===================== The first thing the command loop must do is read a key sequence, which is a sequence of events that translates into a command. It does this by calling the function `read-key-sequence'. Your Lisp code can also call this function (*note Key Sequence Input::.). Lisp programs can also do input at a lower level with `read-event' (*note Reading One Event::.) or discard pending input with `discard-input' (*note Event Input Misc::.). The key sequence is translated into a command through the currently active keymaps. *Note Key Lookup::, for information on how this is done. The result should be a keyboard macro or an interactively callable function. If the key is `M-x', then it reads the name of another command, which it then calls. This is done by the command `execute-extended-command' (*note Interactive Call::.). To execute a command requires first reading the arguments for it. This is done by calling `command-execute' (*note Interactive Call::.). For commands written in Lisp, the `interactive' specification says how to read the arguments. This may use the prefix argument (*note Prefix Command Arguments::.) or may read with prompting in the minibuffer (*note Minibuffers::.). For example, the command `find-file' has an `interactive' specification which says to read a file name using the minibuffer. The command's function body does not use the minibuffer; if you call this command from Lisp code as a function, you must supply the file name string as an ordinary Lisp function argument. If the command is a string or vector (i.e., a keyboard macro) then `execute-kbd-macro' is used to execute it. You can call this function yourself (*note Keyboard Macros::.). To terminate the execution of a running command, type `C-g'. This character causes "quitting" (*note Quitting::.). - Variable: pre-command-hook The editor command loop runs this normal hook before each command. At that time, `this-command' contains the command that is about to run, and `last-command' describes the previous command. *Note Hooks::. - Variable: post-command-hook The editor command loop runs this normal hook after each command (including commands terminated prematurely by quitting or by errors), and also when the command loop is first entered. At that time, `this-command' describes the command that just ran, and `last-command' describes the command before that. *Note Hooks::. Quitting is suppressed while running `pre-command-hook' and `post-command-hook'. If an error happens while executing one of these hooks, it terminates execution of the hook, and clears the hook variable to `nil' so as to prevent an infinite loop of errors. Defining Commands ================= A Lisp function becomes a command when its body contains, at top level, a form that calls the special form `interactive'. This form does nothing when actually executed, but its presence serves as a flag to indicate that interactive calling is permitted. Its argument controls the reading of arguments for an interactive call. Using `interactive' ------------------- This section describes how to write the `interactive' form that makes a Lisp function an interactively-callable command. - Special Form: interactive ARG-DESCRIPTOR This special form declares that the function in which it appears is a command, and that it may therefore be called interactively (via `M-x' or by entering a key sequence bound to it). The argument ARG-DESCRIPTOR declares how to compute the arguments to the command when the command is called interactively. A command may be called from Lisp programs like any other function, but then the caller supplies the arguments and ARG-DESCRIPTOR has no effect. The `interactive' form has its effect because the command loop (actually, its subroutine `call-interactively') scans through the function definition looking for it, before calling the function. Once the function is called, all its body forms including the `interactive' form are executed, but at this time `interactive' simply returns `nil' without even evaluating its argument. There are three possibilities for the argument ARG-DESCRIPTOR: * It may be omitted or `nil'; then the command is called with no arguments. This leads quickly to an error if the command requires one or more arguments. * It may be a Lisp expression that is not a string; then it should be a form that is evaluated to get a list of arguments to pass to the command. If this expression reads keyboard input (this includes using the minibuffer), keep in mind that the integer value of point or the mark before reading input may be incorrect after reading input. This is because the current buffer may be receiving subprocess output; if subprocess output arrives while the command is waiting for input, it could relocate point and the mark. Here's an example of what *not* to do: (interactive (list (region-beginning) (region-end) (read-string "Foo: " nil 'my-history))) Here's how to avoid the problem, by examining point and the mark only after reading the keyboard input: (interactive (let ((string (read-string "Foo: " nil 'my-history))) (list (region-beginning) (region-end) string))) * It may be a string; then its contents should consist of a code character followed by a prompt (which some code characters use and some ignore). The prompt ends either with the end of the string or with a newline. Here is a simple example: (interactive "bFrobnicate buffer: ") The code letter `b' says to read the name of an existing buffer, with completion. The buffer name is the sole argument passed to the command. The rest of the string is a prompt. If there is a newline character in the string, it terminates the prompt. If the string does not end there, then the rest of the string should contain another code character and prompt, specifying another argument. You can specify any number of arguments in this way. The prompt string can use `%' to include previous argument values (starting with the first argument) in the prompt. This is done using `format' (*note Formatting Strings::.). For example, here is how you could read the name of an existing buffer followed by a new name to give to that buffer: (interactive "bBuffer to rename: \nsRename buffer %s to: ") If the first character in the string is `*', then an error is signaled if the buffer is read-only. If the first character in the string is `@', and if the key sequence used to invoke the command includes any mouse events, then the window associated with the first of those events is selected before the command is run. You can use `*' and `@' together; the order does not matter. Actual reading of arguments is controlled by the rest of the prompt string (starting with the first character that is not `*' or `@'). Code Characters for `interactive' --------------------------------- The code character descriptions below contain a number of key words, defined here as follows: Completion Provide completion. , , and perform name completion because the argument is read using `completing-read' (*note Completion::.). `?' displays a list of possible completions. Existing Require the name of an existing object. An invalid name is not accepted; the commands to exit the minibuffer do not exit if the current input is not valid. Default A default value of some sort is used if the user enters no text in the minibuffer. The default depends on the code character. No I/O This code letter computes an argument without reading any input. Therefore, it does not use a prompt string, and any prompt string you supply is ignored. Even though the code letter doesn't use a prompt string, you must follow it with a newline if it is not the last code character in the string. Prompt A prompt immediately follows the code character. The prompt ends either with the end of the string or with a newline. Special This code character is meaningful only at the beginning of the interactive string, and it does not look for a prompt or a newline. It is a single, isolated character. Here are the code character descriptions for use with `interactive': `*' Signal an error if the current buffer is read-only. Special. `@' Select the window mentioned in the first mouse event in the key sequence that invoked this command. Special. `a' A function name (i.e., a symbol satisfying `fboundp'). Existing, Completion, Prompt. `b' The name of an existing buffer. By default, uses the name of the current buffer (*note Buffers::.). Existing, Completion, Default, Prompt. `B' A buffer name. The buffer need not exist. By default, uses the name of a recently used buffer other than the current buffer. Completion, Default, Prompt. `c' A character. The cursor does not move into the echo area. Prompt. `C' A command name (i.e., a symbol satisfying `commandp'). Existing, Completion, Prompt. `d' The position of point, as an integer (*note Point::.). No I/O. `D' A directory name. The default is the current default directory of the current buffer, `default-directory' (*note System Environment::.). Existing, Completion, Default, Prompt. `e' The first or next mouse event in the key sequence that invoked the command. More precisely, `e' gets events that are lists, so you can look at the data in the lists. *Note Input Events::. No I/O. You can use `e' more than once in a single command's interactive specification. If the key sequence that invoked the command has N events that are lists, the Nth `e' provides the Nth such event. Events that are not lists, such as function keys and ASCII characters, do not count where `e' is concerned. `f' A file name of an existing file (*note File Names::.). The default directory is `default-directory'. Existing, Completion, Default, Prompt. `F' A file name. The file need not exist. Completion, Default, Prompt. `i' An irrelevant argument. This code always supplies `nil' as the argument's value. No I/O. `k' A key sequence (*note Keymap Terminology::.). This keeps reading events until a command (or undefined command) is found in the current key maps. The key sequence argument is represented as a string or vector. The cursor does not move into the echo area. Prompt. This kind of input is used by commands such as `describe-key' and `global-set-key'. `K' A key sequence, whose definition you intend to change. This works like `k', except that it suppresses, for the last input event in the key sequence, the conversions that are normally used (when necessary) to convert an undefined key into a defined one. `m' The position of the mark, as an integer. No I/O. `M' Arbitrary text, read in the minibuffer using the current buffer's input method, and returned as a string (*note Input Methods: (emacs)Input Methods.). Prompt. `n' A number read with the minibuffer. If the input is not a number, the user is asked to try again. The prefix argument, if any, is not used. Prompt. `N' The numeric prefix argument; but if there is no prefix argument, read a number as with `n'. Requires a number. *Note Prefix Command Arguments::. Prompt. `p' The numeric prefix argument. (Note that this `p' is lower case.) No I/O. `P' The raw prefix argument. (Note that this `P' is upper case.) No I/O. `r' Point and the mark, as two numeric arguments, smallest first. This is the only code letter that specifies two successive arguments rather than one. No I/O. `s' Arbitrary text, read in the minibuffer and returned as a string (*note Text from Minibuffer::.). Terminate the input with either `C-j' or . (`C-q' may be used to include either of these characters in the input.) Prompt. `S' An interned symbol whose name is read in the minibuffer. Any whitespace character terminates the input. (Use `C-q' to include whitespace in the string.) Other characters that normally terminate a symbol (e.g., parentheses and brackets) do not do so here. Prompt. `v' A variable declared to be a user option (i.e., satisfying the predicate `user-variable-p'). *Note High-Level Completion::. Existing, Completion, Prompt. `x' A Lisp object, specified with its read syntax, terminated with a `C-j' or . The object is not evaluated. *Note Object from Minibuffer::. Prompt. `X' A Lisp form is read as with `x', but then evaluated so that its value becomes the argument for the command. Prompt. `z' A coding system name (a symbol). If the user enters null input, the argument value is `nil'. *Note Coding Systems::. Completion, Existing, Prompt. `Z' A coding system name (a symbol)--but only if this command has a prefix argument. With no prefix argument, `Z' provides `nil' as the argument value. Completion, Existing, Prompt. Examples of Using `interactive' ------------------------------- Here are some examples of `interactive': (defun foo1 () ; `foo1' takes no arguments, (interactive) ; just moves forward two words. (forward-word 2)) => foo1 (defun foo2 (n) ; `foo2' takes one argument, (interactive "p") ; which is the numeric prefix. (forward-word (* 2 n))) => foo2 (defun foo3 (n) ; `foo3' takes one argument, (interactive "nCount:") ; which is read with the Minibuffer. (forward-word (* 2 n))) => foo3 (defun three-b (b1 b2 b3) "Select three existing buffers. Put them into three windows, selecting the last one." (interactive "bBuffer1:\nbBuffer2:\nbBuffer3:") (delete-other-windows) (split-window (selected-window) 8) (switch-to-buffer b1) (other-window 1) (split-window (selected-window) 8) (switch-to-buffer b2) (other-window 1) (switch-to-buffer b3)) => three-b (three-b "*scratch*" "declarations.texi" "*mail*") => nil Interactive Call ================ After the command loop has translated a key sequence into a command it invokes that command using the function `command-execute'. If the command is a function, `command-execute' calls `call-interactively', which reads the arguments and calls the command. You can also call these functions yourself. - Function: commandp OBJECT Returns `t' if OBJECT is suitable for calling interactively; that is, if OBJECT is a command. Otherwise, returns `nil'. The interactively callable objects include strings and vectors (treated as keyboard macros), lambda expressions that contain a top-level call to `interactive', byte-code function objects made from such lambda expressions, autoload objects that are declared as interactive (non-`nil' fourth argument to `autoload'), and some of the primitive functions. A symbol satisfies `commandp' if its function definition satisfies `commandp'. Keys and keymaps are not commands. Rather, they are used to look up commands (*note Keymaps::.). See `documentation' in *Note Accessing Documentation::, for a realistic example of using `commandp'. - Function: call-interactively COMMAND &optional RECORD-FLAG KEYS This function calls the interactively callable function COMMAND, reading arguments according to its interactive calling specifications. An error is signaled if COMMAND is not a function or if it cannot be called interactively (i.e., is not a command). Note that keyboard macros (strings and vectors) are not accepted, even though they are considered commands, because they are not functions. If RECORD-FLAG is non-`nil', then this command and its arguments are unconditionally added to the list `command-history'. Otherwise, the command is added only if it uses the minibuffer to read an argument. *Note Command History::. The argument KEYS, if given, specifies the sequence of events to supply if the command inquires which events were used to invoke it. - Function: command-execute COMMAND &optional RECORD-FLAG KEYS This function executes COMMAND. The argument COMMAND must satisfy the `commandp' predicate; i.e., it must be an interactively callable function or a keyboard macro. A string or vector as COMMAND is executed with `execute-kbd-macro'. A function is passed to `call-interactively', along with the optional RECORD-FLAG. A symbol is handled by using its function definition in its place. A symbol with an `autoload' definition counts as a command if it was declared to stand for an interactively callable function. Such a definition is handled by loading the specified library and then rechecking the definition of the symbol. The argument KEYS, if given, specifies the sequence of events to supply if the command inquires which events were used to invoke it. - Command: execute-extended-command PREFIX-ARGUMENT This function reads a command name from the minibuffer using `completing-read' (*note Completion::.). Then it uses `command-execute' to call the specified command. Whatever that command returns becomes the value of `execute-extended-command'. If the command asks for a prefix argument, it receives the value PREFIX-ARGUMENT. If `execute-extended-command' is called interactively, the current raw prefix argument is used for PREFIX-ARGUMENT, and thus passed on to whatever command is run. `execute-extended-command' is the normal definition of `M-x', so it uses the string `M-x ' as a prompt. (It would be better to take the prompt from the events used to invoke `execute-extended-command', but that is painful to implement.) A description of the value of the prefix argument, if any, also becomes part of the prompt. (execute-extended-command 1) ---------- Buffer: Minibuffer ---------- 1 M-x forward-word RET ---------- Buffer: Minibuffer ---------- => t - Function: interactive-p This function returns `t' if the containing function (the one whose code includes the call to `interactive-p') was called interactively, with the function `call-interactively'. (It makes no difference whether `call-interactively' was called from Lisp or directly from the editor command loop.) If the containing function was called by Lisp evaluation (or with `apply' or `funcall'), then it was not called interactively. The most common use of `interactive-p' is for deciding whether to print an informative message. As a special exception, `interactive-p' returns `nil' whenever a keyboard macro is being run. This is to suppress the informative messages and speed execution of the macro. For example: (defun foo () (interactive) (when (interactive-p) (message "foo"))) => foo (defun bar () (interactive) (setq foobar (list (foo) (interactive-p)))) => bar ;; Type `M-x foo'. -| foo ;; Type `M-x bar'. ;; This does not print anything. foobar => (nil t) The other way to do this sort of job is to make the command take an argument `print-message' which should be non-`nil' in an interactive call, and use the `interactive' spec to make sure it is non-`nil'. Here's how: (defun foo (&optional print-message) (interactive "p") (when print-message (message "foo"))) The numeric prefix argument, provided by `p', is never `nil'. Information from the Command Loop ================================= The editor command loop sets several Lisp variables to keep status records for itself and for commands that are run. - Variable: last-command This variable records the name of the previous command executed by the command loop (the one before the current command). Normally the value is a symbol with a function definition, but this is not guaranteed. The value is copied from `this-command' when a command returns to the command loop, except when the command has specified a prefix argument for the following command. This variable is always local to the current terminal and cannot be buffer-local. *Note Multiple Displays::. - Variable: real-last-command This variable is set up by Emacs just like `last-command', but never altered by Lisp programs. - Variable: this-command This variable records the name of the command now being executed by the editor command loop. Like `last-command', it is normally a symbol with a function definition. The command loop sets this variable just before running a command, and copies its value into `last-command' when the command finishes (unless the command specified a prefix argument for the following command). Some commands set this variable during their execution, as a flag for whatever command runs next. In particular, the functions for killing text set `this-command' to `kill-region' so that any kill commands immediately following will know to append the killed text to the previous kill. If you do not want a particular command to be recognized as the previous command in the case where it got an error, you must code that command to prevent this. One way is to set `this-command' to `t' at the beginning of the command, and set `this-command' back to its proper value at the end, like this: (defun foo (args...) (interactive ...) (let ((old-this-command this-command)) (setq this-command t) ...do the work... (setq this-command old-this-command))) We do not bind `this-command' with `let' because that would restore the old value in case of error--a feature of `let' which in this case does precisely what we want to avoid. - Function: this-command-keys This function returns a string or vector containing the key sequence that invoked the present command, plus any previous commands that generated the prefix argument for this command. The value is a string if all those events were characters. *Note Input Events::. (this-command-keys) ;; Now use `C-u C-x C-e' to evaluate that. => "^U^X^E" - Function: this-command-keys-vector Like `this-command-keys', except that it always returns the events in a vector, so you do never need to deal with the complexities of storing input events in a string (*note Strings of Events::.). - Variable: last-nonmenu-event This variable holds the last input event read as part of a key sequence, not counting events resulting from mouse menus. One use of this variable is for telling `x-popup-menu' where to pop up a menu. It is also used internally by `y-or-n-p' (*note Yes-or-No Queries::.). - Variable: last-command-event - Variable: last-command-char This variable is set to the last input event that was read by the command loop as part of a command. The principal use of this variable is in `self-insert-command', which uses it to decide which character to insert. last-command-event ;; Now use `C-u C-x C-e' to evaluate that. => 5 The value is 5 because that is the ASCII code for `C-e'. The alias `last-command-char' exists for compatibility with Emacs version 18. - Variable: last-event-frame This variable records which frame the last input event was directed to. Usually this is the frame that was selected when the event was generated, but if that frame has redirected input focus to another frame, the value is the frame to which the event was redirected. *Note Input Focus::. Input Events ============ The Emacs command loop reads a sequence of "input events" that represent keyboard or mouse activity. The events for keyboard activity are characters or symbols; mouse events are always lists. This section describes the representation and meaning of input events in detail. - Function: eventp OBJECT This function returns non-`nil' if OBJECT is an input event or event type. Note that any symbol might be used as an event or an event type. `eventp' cannot distinguish whether a symbol is intended by Lisp code to be used as an event. Instead, it distinguishes whether the symbol has actually been used in an event that has been read as input in the current Emacs session. If a symbol has not yet been so used, `eventp' returns `nil'. Keyboard Events --------------- There are two kinds of input you can get from the keyboard: ordinary keys, and function keys. Ordinary keys correspond to characters; the events they generate are represented in Lisp as characters. The event type of a character event is the character itself (an integer); see *Note Classifying Events::. An input character event consists of a "basic code" between 0 and 524287, plus any or all of these "modifier bits": meta The 2**27 bit in the character code indicates a character typed with the meta key held down. control The 2**26 bit in the character code indicates a non-ASCII control character. ASCII control characters such as `C-a' have special basic codes of their own, so Emacs needs no special bit to indicate them. Thus, the code for `C-a' is just 1. But if you type a control combination not in ASCII, such as `%' with the control key, the numeric value you get is the code for `%' plus 2**26 (assuming the terminal supports non-ASCII control characters). shift The 2**25 bit in the character code indicates an ASCII control character typed with the shift key held down. For letters, the basic code itself indicates upper versus lower case; for digits and punctuation, the shift key selects an entirely different character with a different basic code. In order to keep within the ASCII character set whenever possible, Emacs avoids using the 2**25 bit for those characters. However, ASCII provides no way to distinguish `C-A' from `C-a', so Emacs uses the 2**25 bit in `C-A' and not in `C-a'. hyper The 2**24 bit in the character code indicates a character typed with the hyper key held down. super The 2**23 bit in the character code indicates a character typed with the super key held down. alt The 2**22 bit in the character code indicates a character typed with the alt key held down. (On some terminals, the key labeled is actually the meta key.) It is best to avoid mentioning specific bit numbers in your program. To test the modifier bits of a character, use the function `event-modifiers' (*note Classifying Events::.). When making key bindings, you can use the read syntax for characters with modifier bits (`\C-', `\M-', and so on). For making key bindings with `define-key', you can use lists such as `(control hyper ?x)' to specify the characters (*note Changing Key Bindings::.). The function `event-convert-list' converts such a list into an event type (*note Classifying Events::.). Function Keys ------------- Most keyboards also have "function keys"--keys that have names or symbols that are not characters. Function keys are represented in Emacs Lisp as symbols; the symbol's name is the function key's label, in lower case. For example, pressing a key labeled places the symbol `f1' in the input stream. The event type of a function key event is the event symbol itself. *Note Classifying Events::. Here are a few special cases in the symbol-naming convention for function keys: `backspace', `tab', `newline', `return', `delete' These keys correspond to common ASCII control characters that have special keys on most keyboards. In ASCII, `C-i' and are the same character. If the terminal can distinguish between them, Emacs conveys the distinction to Lisp programs by representing the former as the integer 9, and the latter as the symbol `tab'. Most of the time, it's not useful to distinguish the two. So normally `function-key-map' (*note Translating Input::.) is set up to map `tab' into 9. Thus, a key binding for character code 9 (the character `C-i') also applies to `tab'. Likewise for the other symbols in this group. The function `read-char' likewise converts these events into characters. In ASCII, is really `C-h'. But `backspace' converts into the character code 127 (), not into code 8 (). This is what most users prefer. `left', `up', `right', `down' Cursor arrow keys `kp-add', `kp-decimal', `kp-divide', ... Keypad keys (to the right of the regular keyboard). `kp-0', `kp-1', ... Keypad keys with digits. `kp-f1', `kp-f2', `kp-f3', `kp-f4' Keypad PF keys. `kp-home', `kp-left', `kp-up', `kp-right', `kp-down' Keypad arrow keys. Emacs normally translates these into the corresponding non-keypad keys `home', `left', ... `kp-prior', `kp-next', `kp-end', `kp-begin', `kp-insert', `kp-delete' Additional keypad duplicates of keys ordinarily found elsewhere. Emacs normally translates these into the like-named non-keypad keys. You can use the modifier keys , , , , , and with function keys. The way to represent them is with prefixes in the symbol name: `A-' The alt modifier. `C-' The control modifier. `H-' The hyper modifier. `M-' The meta modifier. `S-' The shift modifier. `s-' The super modifier. Thus, the symbol for the key with held down is `M-f3'. When you use more than one prefix, we recommend you write them in alphabetical order; but the order does not matter in arguments to the key-binding lookup and modification functions. Mouse Events ------------ Emacs supports four kinds of mouse events: click events, drag events, button-down events, and motion events. All mouse events are represented as lists. The CAR of the list is the event type; this says which mouse button was involved, and which modifier keys were used with it. The event type can also distinguish double or triple button presses (*note Repeat Events::.). The rest of the list elements give position and time information. For key lookup, only the event type matters: two events of the same type necessarily run the same command. The command can access the full values of these events using the `e' interactive code. *Note Interactive Codes::. A key sequence that starts with a mouse event is read using the keymaps of the buffer in the window that the mouse was in, not the current buffer. This does not imply that clicking in a window selects that window or its buffer--that is entirely under the control of the command binding of the key sequence. Click Events ------------ When the user presses a mouse button and releases it at the same location, that generates a "click" event. Mouse click events have this form: (EVENT-TYPE (WINDOW BUFFER-POS (X . Y) TIMESTAMP) CLICK-COUNT) Here is what the elements normally mean: EVENT-TYPE This is a symbol that indicates which mouse button was used. It is one of the symbols `mouse-1', `mouse-2', ..., where the buttons are numbered left to right. You can also use prefixes `A-', `C-', `H-', `M-', `S-' and `s-' for modifiers alt, control, hyper, meta, shift and super, just as you would with function keys. This symbol also serves as the event type of the event. Key bindings describe events by their types; thus, if there is a key binding for `mouse-1', that binding would apply to all events whose EVENT-TYPE is `mouse-1'. WINDOW This is the window in which the click occurred. X, Y These are the pixel-denominated coordinates of the click, relative to the top left corner of WINDOW, which is `(0 . 0)'. BUFFER-POS This is the buffer position of the character clicked on. TIMESTAMP This is the time at which the event occurred, in milliseconds. (Since this value wraps around the entire range of Emacs Lisp integers in about five hours, it is useful only for relating the times of nearby events.) CLICK-COUNT This is the number of rapid repeated presses so far of the same mouse button. *Note Repeat Events::. The meanings of BUFFER-POS, X and Y are somewhat different when the event location is in a special part of the screen, such as the mode line or a scroll bar. If the location is in a scroll bar, then BUFFER-POS is the symbol `vertical-scroll-bar' or `horizontal-scroll-bar', and the pair `(X . Y)' is replaced with a pair `(PORTION . WHOLE)', where PORTION is the distance of the click from the top or left end of the scroll bar, and WHOLE is the length of the entire scroll bar. If the position is on a mode line or the vertical line separating WINDOW from its neighbor to the right, then BUFFER-POS is the symbol `mode-line' or `vertical-line'. For the mode line, Y does not have meaningful data. For the vertical line, X does not have meaningful data. In one special case, BUFFER-POS is a list containing a symbol (one of the symbols listed above) instead of just the symbol. This happens after the imaginary prefix keys for the event are inserted into the input stream. *Note Key Sequence Input::. Drag Events ----------- With Emacs, you can have a drag event without even changing your clothes. A "drag event" happens every time the user presses a mouse button and then moves the mouse to a different character position before releasing the button. Like all mouse events, drag events are represented in Lisp as lists. The lists record both the starting mouse position and the final position, like this: (EVENT-TYPE (WINDOW1 BUFFER-POS1 (X1 . Y1) TIMESTAMP1) (WINDOW2 BUFFER-POS2 (X2 . Y2) TIMESTAMP2) CLICK-COUNT) For a drag event, the name of the symbol EVENT-TYPE contains the prefix `drag-'. For example, dragging the mouse with button 2 held down generates a `drag-mouse-2' event. The second and third elements of the event give the starting and ending position of the drag. Aside from that, the data have the same meanings as in a click event (*note Click Events::.). You can access the second element of any mouse event in the same way, with no need to distinguish drag events from others. The `drag-' prefix follows the modifier key prefixes such as `C-' and `M-'. If `read-key-sequence' receives a drag event that has no key binding, and the corresponding click event does have a binding, it changes the drag event into a click event at the drag's starting position. This means that you don't have to distinguish between click and drag events unless you want to. Button-Down Events ------------------ Click and drag events happen when the user releases a mouse button. They cannot happen earlier, because there is no way to distinguish a click from a drag until the button is released. If you want to take action as soon as a button is pressed, you need to handle "button-down" events.(1) These occur as soon as a button is pressed. They are represented by lists that look exactly like click events (*note Click Events::.), except that the EVENT-TYPE symbol name contains the prefix `down-'. The `down-' prefix follows modifier key prefixes such as `C-' and `M-'. The function `read-key-sequence' ignores any button-down events that don't have command bindings; therefore, the Emacs command loop ignores them too. This means that you need not worry about defining button-down events unless you want them to do something. The usual reason to define a button-down event is so that you can track mouse motion (by reading motion events) until the button is released. *Note Motion Events::. ---------- Footnotes ---------- (1) Button-down is the conservative antithesis of drag. Repeat Events ------------- If you press the same mouse button more than once in quick succession without moving the mouse, Emacs generates special "repeat" mouse events for the second and subsequent presses. The most common repeat events are "double-click" events. Emacs generates a double-click event when you click a button twice; the event happens when you release the button (as is normal for all click events). The event type of a double-click event contains the prefix `double-'. Thus, a double click on the second mouse button with held down comes to the Lisp program as `M-double-mouse-2'. If a double-click event has no binding, the binding of the corresponding ordinary click event is used to execute it. Thus, you need not pay attention to the double click feature unless you really want to. When the user performs a double click, Emacs generates first an ordinary click event, and then a double-click event. Therefore, you must design the command binding of the double click event to assume that the single-click command has already run. It must produce the desired results of a double click, starting from the results of a single click. This is convenient, if the meaning of a double click somehow "builds on" the meaning of a single click--which is recommended user interface design practice for double clicks. If you click a button, then press it down again and start moving the mouse with the button held down, then you get a "double-drag" event when you ultimately release the button. Its event type contains `double-drag' instead of just `drag'. If a double-drag event has no binding, Emacs looks for an alternate binding as if the event were an ordinary drag. Before the double-click or double-drag event, Emacs generates a "double-down" event when the user presses the button down for the second time. Its event type contains `double-down' instead of just `down'. If a double-down event has no binding, Emacs looks for an alternate binding as if the event were an ordinary button-down event. If it finds no binding that way either, the double-down event is ignored. To summarize, when you click a button and then press it again right away, Emacs generates a down event and a click event for the first click, a double-down event when you press the button again, and finally either a double-click or a double-drag event. If you click a button twice and then press it again, all in quick succession, Emacs generates a "triple-down" event, followed by either a "triple-click" or a "triple-drag". The event types of these events contain `triple' instead of `double'. If any triple event has no binding, Emacs uses the binding that it would use for the corresponding double event. If you click a button three or more times and then press it again, the events for the presses beyond the third are all triple events. Emacs does not have separate event types for quadruple, quintuple, etc. events. However, you can look at the event list to find out precisely how many times the button was pressed. - Function: event-click-count EVENT This function returns the number of consecutive button presses that led up to EVENT. If EVENT is a double-down, double-click or double-drag event, the value is 2. If EVENT is a triple event, the value is 3 or greater. If EVENT is an ordinary mouse event (not a repeat event), the value is 1. - Variable: double-click-time To generate repeat events, successive mouse button presses must be at the same screen position, and the number of milliseconds between successive button presses must be less than the value of `double-click-time'. Setting `double-click-time' to `nil' disables multi-click detection entirely. Setting it to `t' removes the time limit; Emacs then detects multi-clicks by position only. Motion Events ------------- Emacs sometimes generates "mouse motion" events to describe motion of the mouse without any button activity. Mouse motion events are represented by lists that look like this: (mouse-movement (WINDOW BUFFER-POS (X . Y) TIMESTAMP)) The second element of the list describes the current position of the mouse, just as in a click event (*note Click Events::.). The special form `track-mouse' enables generation of motion events within its body. Outside of `track-mouse' forms, Emacs does not generate events for mere motion of the mouse, and these events do not appear. *Note Mouse Tracking::. Focus Events ------------ Window systems provide general ways for the user to control which window gets keyboard input. This choice of window is called the "focus". When the user does something to switch between Emacs frames, that generates a "focus event". The normal definition of a focus event, in the global keymap, is to select a new frame within Emacs, as the user would expect. *Note Input Focus::. Focus events are represented in Lisp as lists that look like this: (switch-frame NEW-FRAME) where NEW-FRAME is the frame switched to. Most X window managers are set up so that just moving the mouse into a window is enough to set the focus there. Emacs appears to do this, because it changes the cursor to solid in the new frame. However, there is no need for the Lisp program to know about the focus change until some other kind of input arrives. So Emacs generates a focus event only when the user actually types a keyboard key or presses a mouse button in the new frame; just moving the mouse between frames does not generate a focus event. A focus event in the middle of a key sequence would garble the sequence. So Emacs never generates a focus event in the middle of a key sequence. If the user changes focus in the middle of a key sequence--that is, after a prefix key--then Emacs reorders the events so that the focus event comes either before or after the multi-event key sequence, and not within it. Miscellaneous Window System Events ---------------------------------- A few other event types represent occurrences within the window system. `(delete-frame (FRAME))' This kind of event indicates that the user gave the window manager a command to delete a particular window, which happens to be an Emacs frame. The standard definition of the `delete-frame' event is to delete FRAME. `(iconify-frame (FRAME))' This kind of event indicates that the user iconified FRAME using the window manager. Its standard definition is `ignore'; since the frame has already been iconified, Emacs has no work to do. The purpose of this event type is so that you can keep track of such events if you want to. `(make-frame-visible (FRAME))' This kind of event indicates that the user deiconified FRAME using the window manager. Its standard definition is `ignore'; since the frame has already been made visible, Emacs has no work to do. `(mouse-wheel POSITION DELTA)' This kind of event is generated by moving a wheel on a mouse (such as the MS Intellimouse). Its effect is typically a kind of scroll or zoom. The element DELTA describes the amount and direction of the wheel rotation. Its absolute value is the number of increments by which the wheel was rotated. A negative DELTA indicates that the wheel was rotated backwards, towards the user, and a positive DELTA indicates that the wheel was rotated forward, away from the user. The element POSITION is a list describing the position of the event, in the same format as used in a mouse-click event. This kind of event is generated only on some kinds of systems. `(drag-n-drop POSITION FILES)' This kind of event is generated when a group of files is selected in an application outside of Emacs, and then dragged and dropped onto an Emacs frame. The element POSITION is a list describing the position of the event, in the same format as used in a mouse-click event, and FILES is the list of file names that were dragged and dropped. The usual way to handle this event is by visiting these files. This kind of event is generated, at present, only on some kinds of systems. If one of these events arrives in the middle of a key sequence--that is, after a prefix key--then Emacs reorders the events so that this event comes either before or after the multi-event key sequence, not within it. Event Examples -------------- If the user presses and releases the left mouse button over the same location, that generates a sequence of events like this: (down-mouse-1 (# 2613 (0 . 38) -864320)) (mouse-1 (# 2613 (0 . 38) -864180)) While holding the control key down, the user might hold down the second mouse button, and drag the mouse from one line to the next. That produces two events, as shown here: (C-down-mouse-2 (# 3440 (0 . 27) -731219)) (C-drag-mouse-2 (# 3440 (0 . 27) -731219) (# 3510 (0 . 28) -729648)) While holding down the meta and shift keys, the user might press the second mouse button on the window's mode line, and then drag the mouse into another window. That produces a pair of events like these: (M-S-down-mouse-2 (# mode-line (33 . 31) -457844)) (M-S-drag-mouse-2 (# mode-line (33 . 31) -457844) (# 161 (33 . 3) -453816)) Classifying Events ------------------ Every event has an "event type", which classifies the event for key binding purposes. For a keyboard event, the event type equals the event value; thus, the event type for a character is the character, and the event type for a function key symbol is the symbol itself. For events that are lists, the event type is the symbol in the CAR of the list. Thus, the event type is always a symbol or a character. Two events of the same type are equivalent where key bindings are concerned; thus, they always run the same command. That does not necessarily mean they do the same things, however, as some commands look at the whole event to decide what to do. For example, some commands use the location of a mouse event to decide where in the buffer to act. Sometimes broader classifications of events are useful. For example, you might want to ask whether an event involved the key, regardless of which other key or mouse button was used. The functions `event-modifiers' and `event-basic-type' are provided to get such information conveniently. - Function: event-modifiers EVENT This function returns a list of the modifiers that EVENT has. The modifiers are symbols; they include `shift', `control', `meta', `alt', `hyper' and `super'. In addition, the modifiers list of a mouse event symbol always contains one of `click', `drag', and `down'. The argument EVENT may be an entire event object, or just an event type. Here are some examples: (event-modifiers ?a) => nil (event-modifiers ?\C-a) => (control) (event-modifiers ?\C-%) => (control) (event-modifiers ?\C-\S-a) => (control shift) (event-modifiers 'f5) => nil (event-modifiers 's-f5) => (super) (event-modifiers 'M-S-f5) => (meta shift) (event-modifiers 'mouse-1) => (click) (event-modifiers 'down-mouse-1) => (down) The modifiers list for a click event explicitly contains `click', but the event symbol name itself does not contain `click'. - Function: event-basic-type EVENT This function returns the key or mouse button that EVENT describes, with all modifiers removed. For example: (event-basic-type ?a) => 97 (event-basic-type ?A) => 97 (event-basic-type ?\C-a) => 97 (event-basic-type ?\C-\S-a) => 97 (event-basic-type 'f5) => f5 (event-basic-type 's-f5) => f5 (event-basic-type 'M-S-f5) => f5 (event-basic-type 'down-mouse-1) => mouse-1 - Function: mouse-movement-p OBJECT This function returns non-`nil' if OBJECT is a mouse movement event. - Function: event-convert-list LIST This function converts a list of modifier names and a basic event type to an event type which specifies all of them. For example, (event-convert-list '(control ?a)) => 1 (event-convert-list '(control meta ?a)) => -134217727 (event-convert-list '(control super f1)) => C-s-f1 Accessing Events ---------------- This section describes convenient functions for accessing the data in a mouse button or motion event. These two functions return the starting or ending position of a mouse-button event, as a list of this form: (WINDOW BUFFER-POSITION (X . Y) TIMESTAMP) - Function: event-start EVENT This returns the starting position of EVENT. If EVENT is a click or button-down event, this returns the location of the event. If EVENT is a drag event, this returns the drag's starting position. - Function: event-end EVENT This returns the ending position of EVENT. If EVENT is a drag event, this returns the position where the user released the mouse button. If EVENT is a click or button-down event, the value is actually the starting position, which is the only position such events have. These five functions take a position list as described above, and return various parts of it. - Function: posn-window POSITION Return the window that POSITION is in. - Function: posn-point POSITION Return the buffer position in POSITION. This is an integer. - Function: posn-x-y POSITION Return the pixel-based x and y coordinates in POSITION, as a cons cell `(X . Y)'. - Function: posn-col-row POSITION Return the row and column (in units of characters) of POSITION, as a cons cell `(COL . ROW)'. These are computed from the X and Y values actually found in POSITION. - Function: posn-timestamp POSITION Return the timestamp in POSITION. These functions are useful for decoding scroll bar events. - Function: scroll-bar-event-ratio EVENT This function returns the fractional vertical position of a scroll bar event within the scroll bar. The value is a cons cell `(PORTION . WHOLE)' containing two integers whose ratio is the fractional position. - Function: scroll-bar-scale RATIO TOTAL This function multiplies (in effect) RATIO by TOTAL, rounding the result to an integer. The argument RATIO is not a number, but rather a pair `(NUM . DENOM)'--typically a value returned by `scroll-bar-event-ratio'. This function is handy for scaling a position on a scroll bar into a buffer position. Here's how to do that: (+ (point-min) (scroll-bar-scale (posn-x-y (event-start event)) (- (point-max) (point-min)))) Recall that scroll bar events have two integers forming a ratio, in place of a pair of x and y coordinates. Putting Keyboard Events in Strings ---------------------------------- In most of the places where strings are used, we conceptualize the string as containing text characters--the same kind of characters found in buffers or files. Occasionally Lisp programs use strings that conceptually contain keyboard characters; for example, they may be key sequences or keyboard macro definitions. However, storing keyboard characters in a string is a complex matter, for reasons of historical compatibility, and it is not always possible. We recommend that new programs avoid dealing with these complexities by not storing keyboard events in strings. Here is how to do that: * Use vectors instead of strings for key sequences, when you plan to use them for anything other than as arguments to `lookup-key' and `define-key'. For example, you can use `read-key-sequence-vector' instead of `read-key-sequence', and `this-command-keys-vector' instead of `this-command-keys'. * Use vectors to write key sequence constants containing meta characters, even when passing them directly to `define-key'. * When you have to look at the contents of a key sequence that might be a string, use `listify-key-sequence' (*note Event Input Misc::.) first, to convert it to a list. The complexities stem from the modifier bits that keyboard input characters can include. Aside from the Meta modifier, none of these modifier bits can be included in a string, and the Meta modifier is allowed only in special cases. The earliest GNU Emacs versions represented meta characters as codes in the range of 128 to 255. At that time, the basic character codes ranged from 0 to 127, so all keyboard character codes did fit in a string. Many Lisp programs used `\M-' in string constants to stand for meta characters, especially in arguments to `define-key' and similar functions, and key sequences and sequences of events were always represented as strings. When we added support for larger basic character codes beyond 127, and additional modifier bits, we had to change the representation of meta characters. Now the flag that represents the Meta modifier in a character is 2**27 and such numbers cannot be included in a string. To support programs with `\M-' in string constants, there are special rules for including certain meta characters in a string. Here are the rules for interpreting a string as a sequence of input characters: * If the keyboard character value is in the range of 0 to 127, it can go in the string unchanged. * The meta variants of those characters, with codes in the range of 2**27 to 2**27+127, can also go in the string, but you must change their numeric values. You must set the 2**7 bit instead of the 2**27 bit, resulting in a value between 128 and 255. Only a unibyte string can include these codes. * Non-ASCII characters above 256 can be included in a multibyte string. * Other keyboard character events cannot fit in a string. This includes keyboard events in the range of 128 to 255. Functions such as `read-key-sequence' that construct strings of keyboard input characters follow these rules: they construct vectors instead of strings, when the events won't fit in a string. When you use the read syntax `\M-' in a string, it produces a code in the range of 128 to 255--the same code that you get if you modify the corresponding keyboard event to put it in the string. Thus, meta events in strings work consistently regardless of how they get into the strings. However, most programs would do well to avoid these issues by following the recommendations at the beginning of this section. Reading Input ============= The editor command loop reads key sequences using the function `read-key-sequence', which uses `read-event'. These and other functions for event input are also available for use in Lisp programs. See also `momentary-string-display' in *Note Temporary Displays::, and `sit-for' in *Note Waiting::. *Note Terminal Input::, for functions and variables for controlling terminal input modes and debugging terminal input. *Note Translating Input::, for features you can use for translating or modifying input events while reading them. For higher-level input facilities, see *Note Minibuffers::. Key Sequence Input ------------------ The command loop reads input a key sequence at a time, by calling `read-key-sequence'. Lisp programs can also call this function; for example, `describe-key' uses it to read the key to describe. - Function: read-key-sequence PROMPT This function reads a key sequence and returns it as a string or vector. It keeps reading events until it has accumulated a complete key sequence; that is, enough to specify a non-prefix command using the currently active keymaps. If the events are all characters and all can fit in a string, then `read-key-sequence' returns a string (*note Strings of Events::.). Otherwise, it returns a vector, since a vector can hold all kinds of events--characters, symbols, and lists. The elements of the string or vector are the events in the key sequence. The argument PROMPT is either a string to be displayed in the echo area as a prompt, or `nil', meaning not to display a prompt. In the example below, the prompt `?' is displayed in the echo area, and the user types `C-x C-f'. (read-key-sequence "?") ---------- Echo Area ---------- ?C-x C-f ---------- Echo Area ---------- => "^X^F" The function `read-key-sequence' suppresses quitting: `C-g' typed while reading with this function works like any other character, and does not set `quit-flag'. *Note Quitting::. - Function: read-key-sequence-vector PROMPT This is like `read-key-sequence' except that it always returns the key sequence as a vector, never as a string. *Note Strings of Events::. If an input character is an upper-case letter and has no key binding, but its lower-case equivalent has one, then `read-key-sequence' converts the character to lower case. Note that `lookup-key' does not perform case conversion in this way. The function `read-key-sequence' also transforms some mouse events. It converts unbound drag events into click events, and discards unbound button-down events entirely. It also reshuffles focus events and miscellaneous window events so that they never appear in a key sequence with any other events. When mouse events occur in special parts of a window, such as a mode line or a scroll bar, the event type shows nothing special--it is the same symbol that would normally represent that combination of mouse button and modifier keys. The information about the window part is kept elsewhere in the event--in the coordinates. But `read-key-sequence' translates this information into imaginary "prefix keys", all of which are symbols: `mode-line', `vertical-line', `horizontal-scroll-bar' and `vertical-scroll-bar'. You can define meanings for mouse clicks in special window parts by defining key sequences using these imaginary prefix keys. For example, if you call `read-key-sequence' and then click the mouse on the window's mode line, you get two events, like this: (read-key-sequence "Click on the mode line: ") => [mode-line (mouse-1 (# mode-line (40 . 63) 5959987))] - Variable: num-input-keys This variable's value is the number of key sequences processed so far in this Emacs session. This includes key sequences read from the terminal and key sequences read from keyboard macros being executed. - Variable: num-nonmacro-input-events This variable holds the total number of input events received so far from the terminal--not counting those generated by keyboard macros. Reading One Event ----------------- The lowest level functions for command input are those that read a single event. - Function: read-event &optional PROMPT SUPPRESS-INPUT-METHOD This function reads and returns the next event of command input, waiting if necessary until an event is available. Events can come directly from the user or from a keyboard macro. If PROMPT is non-`nil', it should be a string to display in the echo area as a prompt. Otherwise, `read-event' does not display any message to indicate it is waiting for input; instead, it prompts by echoing: it displays descriptions of the events that led to or were read by the current command. *Note The Echo Area::. If SUPPRESS-INPUT-METHOD is non-`nil', then the current input method is disabled for reading this event. If you want to read an event without input-method processing, always do it this way; don't try binding `input-method-function' (see below). If `cursor-in-echo-area' is non-`nil', then `read-event' moves the cursor temporarily to the echo area, to the end of any message displayed there. Otherwise `read-event' does not move the cursor. If `read-event' gets an event that is defined as a help character, in some cases `read-event' processes the event directly without returning. *Note Help Functions::. Certain other events, called "special events", are also processed directly within `read-event' (*note Special Events::.). Here is what happens if you call `read-event' and then press the right-arrow function key: (read-event) => right - Function: read-char This function reads and returns a character of command input. It discards any events that are not characters, until it gets a character. In the first example, the user types the character `1' (ASCII code 49). The second example shows a keyboard macro definition that calls `read-char' from the minibuffer using `eval-expression'. `read-char' reads the keyboard macro's very next character, which is `1'. Then `eval-expression' displays its return value in the echo area. (read-char) => 49 ;; We assume here you use `M-:' to evaluate this. (symbol-function 'foo) => "^[:(read-char)^M1" (execute-kbd-macro 'foo) -| 49 => nil `read-event' also invokes the current input method, if any. If the value of `input-method-function' is non-`nil', it should be a function; when `read-event' reads a printing character (including ) with no modifier bits, it calls that function, passing the event as an argument. - Variable: input-method-function If this is non-`nil', its value specifies the current input method function. *Note:* Don't bind this variable with `let'. It is often buffer-local, and if you bind it around reading input (which is exactly when you *would* bind it), switching buffers asynchronously while Emacs is waiting will cause the value to be restored in the wrong buffer. The input method function should return a list of events which should be used as input. (If the list is `nil', that means there is no input, so `read-event' waits for another event.) These events are processed before the events in `unread-command-events'. Events returned by the input method function are not passed to the input method function again, even if they are printing characters with no modifier bits. If the input method function calls `read-event' or `read-key-sequence', it should bind `input-method-function' to `nil' first, to prevent recursion. The input method function is not called when reading the second and subsequent event of a key sequence. Thus, these characters are not subject to input method processing. It is usually a good idea for the input method processing to test the values of `overriding-local-map' and `overriding-terminal-local-map'; if either of these variables is non-`nil', the input method should put its argument into a list and return that list with no further processing. Quoted Character Input ---------------------- You can use the function `read-quoted-char' to ask the user to specify a character, and allow the user to specify a control or meta character conveniently, either literally or as an octal character code. The command `quoted-insert' uses this function. - Function: read-quoted-char &optional PROMPT This function is like `read-char', except that if the first character read is an octal digit (0-7), it reads any number of octal digits (but stopping if a non-octal digit is found), and returns the character represented by that numeric character code. Quitting is suppressed when the first character is read, so that the user can enter a `C-g'. *Note Quitting::. If PROMPT is supplied, it specifies a string for prompting the user. The prompt string is always displayed in the echo area, followed by a single `-'. In the following example, the user types in the octal number 177 (which is 127 in decimal). (read-quoted-char "What character") ---------- Echo Area ---------- What character-177 ---------- Echo Area ---------- => 127 Miscellaneous Event Input Features ---------------------------------- This section describes how to "peek ahead" at events without using them up, how to check for pending input, and how to discard pending input. See also the function `read-passwd' (*note Reading a Password::.). - Variable: unread-command-events This variable holds a list of events waiting to be read as command input. The events are used in the order they appear in the list, and removed one by one as they are used. The variable is needed because in some cases a function reads an event and then decides not to use it. Storing the event in this variable causes it to be processed normally, by the command loop or by the functions to read command input. For example, the function that implements numeric prefix arguments reads any number of digits. When it finds a non-digit event, it must unread the event so that it can be read normally by the command loop. Likewise, incremental search uses this feature to unread events with no special meaning in a search, because these events should exit the search and then execute normally. The reliable and easy way to extract events from a key sequence so as to put them in `unread-command-events' is to use `listify-key-sequence' (*note Strings of Events::.). Normally you add events to the front of this list, so that the events most recently unread will be reread first. - Function: listify-key-sequence KEY This function converts the string or vector KEY to a list of individual events, which you can put in `unread-command-events'. - Variable: unread-command-char This variable holds a character to be read as command input. A value of -1 means "empty". This variable is mostly obsolete now that you can use `unread-command-events' instead; it exists only to support programs written for Emacs versions 18 and earlier. - Function: input-pending-p This function determines whether any command input is currently available to be read. It returns immediately, with value `t' if there is available input, `nil' otherwise. On rare occasions it may return `t' when no input is available. - Variable: last-input-event - Variable: last-input-char This variable records the last terminal input event read, whether as part of a command or explicitly by a Lisp program. In the example below, the Lisp program reads the character `1', ASCII code 49. It becomes the value of `last-input-event', while `C-e' (we assume `C-x C-e' command is used to evaluate this expression) remains the value of `last-command-event'. (progn (print (read-char)) (print last-command-event) last-input-event) -| 49 -| 5 => 49 The alias `last-input-char' exists for compatibility with Emacs version 18. - Function: discard-input This function discards the contents of the terminal input buffer and cancels any keyboard macro that might be in the process of definition. It returns `nil'. In the following example, the user may type a number of characters right after starting the evaluation of the form. After the `sleep-for' finishes sleeping, `discard-input' discards any characters typed during the sleep. (progn (sleep-for 2) (discard-input)) => nil Special Events ============== Special events are handled at a very low level--as soon as they are read. The `read-event' function processes these events itself, and never returns them. Events that are handled in this way do not echo, they are never grouped into key sequences, and they never appear in the value of `last-command-event' or `(this-command-keys)'. They do not discard a numeric argument, they cannot be unread with `unread-command-events', they may not appear in a keyboard macro, and they are not recorded in a keyboard macro while you are defining one. These events do, however, appear in `last-input-event' immediately after they are read, and this is the way for the event's definition to find the actual event. The events types `iconify-frame', `make-frame-visible' and `delete-frame' are normally handled in this way. The keymap which defines how to handle special events--and which events are special--is in the variable `special-event-map' (*note Active Keymaps::.). Waiting for Elapsed Time or Input ================================= The wait functions are designed to wait for a certain amount of time to pass or until there is input. For example, you may wish to pause in the middle of a computation to allow the user time to view the display. `sit-for' pauses and updates the screen, and returns immediately if input comes in, while `sleep-for' pauses without updating the screen. - Function: sit-for SECONDS &optional MILLISEC NODISP This function performs redisplay (provided there is no pending input from the user), then waits SECONDS seconds, or until input is available. The value is `t' if `sit-for' waited the full time with no input arriving (see `input-pending-p' in *Note Event Input Misc::). Otherwise, the value is `nil'. The argument SECONDS need not be an integer. If it is a floating point number, `sit-for' waits for a fractional number of seconds. Some systems support only a whole number of seconds; on these systems, SECONDS is rounded down. The optional argument MILLISEC specifies an additional waiting period measured in milliseconds. This adds to the period specified by SECONDS. If the system doesn't support waiting fractions of a second, you get an error if you specify nonzero MILLISEC. Redisplay is always preempted if input arrives, and does not happen at all if input is available before it starts. Thus, there is no way to force screen updating if there is pending input; however, if there is no input pending, you can force an update with no delay by using `(sit-for 0)'. If NODISP is non-`nil', then `sit-for' does not redisplay, but it still returns as soon as input is available (or when the timeout elapses). Iconifying or deiconifying a frame makes `sit-for' return, because that generates an event. *Note Misc Events::. The usual purpose of `sit-for' is to give the user time to read text that you display. - Function: sleep-for SECONDS &optional MILLISEC This function simply pauses for SECONDS seconds without updating the display. It pays no attention to available input. It returns `nil'. The argument SECONDS need not be an integer. If it is a floating point number, `sleep-for' waits for a fractional number of seconds. Some systems support only a whole number of seconds; on these systems, SECONDS is rounded down. The optional argument MILLISEC specifies an additional waiting period measured in milliseconds. This adds to the period specified by SECONDS. If the system doesn't support waiting fractions of a second, you get an error if you specify nonzero MILLISEC. Use `sleep-for' when you wish to guarantee a delay. *Note Time of Day::, for functions to get the current time. Quitting ======== Typing `C-g' while a Lisp function is running causes Emacs to "quit" whatever it is doing. This means that control returns to the innermost active command loop. Typing `C-g' while the command loop is waiting for keyboard input does not cause a quit; it acts as an ordinary input character. In the simplest case, you cannot tell the difference, because `C-g' normally runs the command `keyboard-quit', whose effect is to quit. However, when `C-g' follows a prefix key, they combine to form an undefined key. The effect is to cancel the prefix key as well as any prefix argument. In the minibuffer, `C-g' has a different definition: it aborts out of the minibuffer. This means, in effect, that it exits the minibuffer and then quits. (Simply quitting would return to the command loop *within* the minibuffer.) The reason why `C-g' does not quit directly when the command reader is reading input is so that its meaning can be redefined in the minibuffer in this way. `C-g' following a prefix key is not redefined in the minibuffer, and it has its normal effect of canceling the prefix key and prefix argument. This too would not be possible if `C-g' always quit directly. When `C-g' does directly quit, it does so by setting the variable `quit-flag' to `t'. Emacs checks this variable at appropriate times and quits if it is not `nil'. Setting `quit-flag' non-`nil' in any way thus causes a quit. At the level of C code, quitting cannot happen just anywhere; only at the special places that check `quit-flag'. The reason for this is that quitting at other places might leave an inconsistency in Emacs's internal state. Because quitting is delayed until a safe place, quitting cannot make Emacs crash. Certain functions such as `read-key-sequence' or `read-quoted-char' prevent quitting entirely even though they wait for input. Instead of quitting, `C-g' serves as the requested input. In the case of `read-key-sequence', this serves to bring about the special behavior of `C-g' in the command loop. In the case of `read-quoted-char', this is so that `C-q' can be used to quote a `C-g'. You can prevent quitting for a portion of a Lisp function by binding the variable `inhibit-quit' to a non-`nil' value. Then, although `C-g' still sets `quit-flag' to `t' as usual, the usual result of this--a quit--is prevented. Eventually, `inhibit-quit' will become `nil' again, such as when its binding is unwound at the end of a `let' form. At that time, if `quit-flag' is still non-`nil', the requested quit happens immediately. This behavior is ideal when you wish to make sure that quitting does not happen within a "critical section" of the program. In some functions (such as `read-quoted-char'), `C-g' is handled in a special way that does not involve quitting. This is done by reading the input with `inhibit-quit' bound to `t', and setting `quit-flag' to `nil' before `inhibit-quit' becomes `nil' again. This excerpt from the definition of `read-quoted-char' shows how this is done; it also shows that normal quitting is permitted after the first character of input. (defun read-quoted-char (&optional prompt) "...DOCUMENTATION..." (let ((message-log-max nil) done (first t) (code 0) char) (while (not done) (let ((inhibit-quit first) ...) (and prompt (message "%s-" prompt)) (setq char (read-event)) (if inhibit-quit (setq quit-flag nil))) ...set the variable `code'...) code)) - Variable: quit-flag If this variable is non-`nil', then Emacs quits immediately, unless `inhibit-quit' is non-`nil'. Typing `C-g' ordinarily sets `quit-flag' non-`nil', regardless of `inhibit-quit'. - Variable: inhibit-quit This variable determines whether Emacs should quit when `quit-flag' is set to a value other than `nil'. If `inhibit-quit' is non-`nil', then `quit-flag' has no special effect. - Command: keyboard-quit This function signals the `quit' condition with `(signal 'quit nil)'. This is the same thing that quitting does. (See `signal' in *Note Errors::.) You can specify a character other than `C-g' to use for quitting. See the function `set-input-mode' in *Note Terminal Input::. Prefix Command Arguments ======================== Most Emacs commands can use a "prefix argument", a number specified before the command itself. (Don't confuse prefix arguments with prefix keys.) The prefix argument is at all times represented by a value, which may be `nil', meaning there is currently no prefix argument. Each command may use the prefix argument or ignore it. There are two representations of the prefix argument: "raw" and "numeric". The editor command loop uses the raw representation internally, and so do the Lisp variables that store the information, but commands can request either representation. Here are the possible values of a raw prefix argument: * `nil', meaning there is no prefix argument. Its numeric value is 1, but numerous commands make a distinction between `nil' and the integer 1. * An integer, which stands for itself. * A list of one element, which is an integer. This form of prefix argument results from one or a succession of `C-u''s with no digits. The numeric value is the integer in the list, but some commands make a distinction between such a list and an integer alone. * The symbol `-'. This indicates that `M--' or `C-u -' was typed, without following digits. The equivalent numeric value is -1, but some commands make a distinction between the integer -1 and the symbol `-'. We illustrate these possibilities by calling the following function with various prefixes: (defun display-prefix (arg) "Display the value of the raw prefix arg." (interactive "P") (message "%s" arg)) Here are the results of calling `display-prefix' with various raw prefix arguments: M-x display-prefix -| nil C-u M-x display-prefix -| (4) C-u C-u M-x display-prefix -| (16) C-u 3 M-x display-prefix -| 3 M-3 M-x display-prefix -| 3 ; (Same as `C-u 3'.) C-u - M-x display-prefix -| - M-- M-x display-prefix -| - ; (Same as `C-u -'.) C-u - 7 M-x display-prefix -| -7 M-- 7 M-x display-prefix -| -7 ; (Same as `C-u -7'.) Emacs uses two variables to store the prefix argument: `prefix-arg' and `current-prefix-arg'. Commands such as `universal-argument' that set up prefix arguments for other commands store them in `prefix-arg'. In contrast, `current-prefix-arg' conveys the prefix argument to the current command, so setting it has no effect on the prefix arguments for future commands. Normally, commands specify which representation to use for the prefix argument, either numeric or raw, in the `interactive' declaration. (*Note Using Interactive::.) Alternatively, functions may look at the value of the prefix argument directly in the variable `current-prefix-arg', but this is less clean. - Function: prefix-numeric-value ARG This function returns the numeric meaning of a valid raw prefix argument value, ARG. The argument may be a symbol, a number, or a list. If it is `nil', the value 1 is returned; if it is `-', the value -1 is returned; if it is a number, that number is returned; if it is a list, the CAR of that list (which should be a number) is returned. - Variable: current-prefix-arg This variable holds the raw prefix argument for the *current* command. Commands may examine it directly, but the usual method for accessing it is with `(interactive "P")'. - Variable: prefix-arg The value of this variable is the raw prefix argument for the *next* editing command. Commands such as `universal-argument' that specify prefix arguments for the following command work by setting this variable. - Variable: last-prefix-arg The raw prefix argument value used by the previous command. The following commands exist to set up prefix arguments for the following command. Do not call them for any other reason. - Command: universal-argument This command reads input and specifies a prefix argument for the following command. Don't call this command yourself unless you know what you are doing. - Command: digit-argument ARG This command adds to the prefix argument for the following command. The argument ARG is the raw prefix argument as it was before this command; it is used to compute the updated prefix argument. Don't call this command yourself unless you know what you are doing. - Command: negative-argument ARG This command adds to the numeric argument for the next command. The argument ARG is the raw prefix argument as it was before this command; its value is negated to form the new prefix argument. Don't call this command yourself unless you know what you are doing. Recursive Editing ================= The Emacs command loop is entered automatically when Emacs starts up. This top-level invocation of the command loop never exits; it keeps running as long as Emacs does. Lisp programs can also invoke the command loop. Since this makes more than one activation of the command loop, we call it "recursive editing". A recursive editing level has the effect of suspending whatever command invoked it and permitting the user to do arbitrary editing before resuming that command. The commands available during recursive editing are the same ones available in the top-level editing loop and defined in the keymaps. Only a few special commands exit the recursive editing level; the others return to the recursive editing level when they finish. (The special commands for exiting are always available, but they do nothing when recursive editing is not in progress.) All command loops, including recursive ones, set up all-purpose error handlers so that an error in a command run from the command loop will not exit the loop. Minibuffer input is a special kind of recursive editing. It has a few special wrinkles, such as enabling display of the minibuffer and the minibuffer window, but fewer than you might suppose. Certain keys behave differently in the minibuffer, but that is only because of the minibuffer's local map; if you switch windows, you get the usual Emacs commands. To invoke a recursive editing level, call the function `recursive-edit'. This function contains the command loop; it also contains a call to `catch' with tag `exit', which makes it possible to exit the recursive editing level by throwing to `exit' (*note Catch and Throw::.). If you throw a value other than `t', then `recursive-edit' returns normally to the function that called it. The command `C-M-c' (`exit-recursive-edit') does this. Throwing a `t' value causes `recursive-edit' to quit, so that control returns to the command loop one level up. This is called "aborting", and is done by `C-]' (`abort-recursive-edit'). Most applications should not use recursive editing, except as part of using the minibuffer. Usually it is more convenient for the user if you change the major mode of the current buffer temporarily to a special major mode, which should have a command to go back to the previous mode. (The `e' command in Rmail uses this technique.) Or, if you wish to give the user different text to edit "recursively", create and select a new buffer in a special mode. In this mode, define a command to complete the processing and go back to the previous buffer. (The `m' command in Rmail does this.) Recursive edits are useful in debugging. You can insert a call to `debug' into a function definition as a sort of breakpoint, so that you can look around when the function gets there. `debug' invokes a recursive edit but also provides the other features of the debugger. Recursive editing levels are also used when you type `C-r' in `query-replace' or use `C-x q' (`kbd-macro-query'). - Function: recursive-edit This function invokes the editor command loop. It is called automatically by the initialization of Emacs, to let the user begin editing. When called from a Lisp program, it enters a recursive editing level. In the following example, the function `simple-rec' first advances point one word, then enters a recursive edit, printing out a message in the echo area. The user can then do any editing desired, and then type `C-M-c' to exit and continue executing `simple-rec'. (defun simple-rec () (forward-word 1) (message "Recursive edit in progress") (recursive-edit) (forward-word 1)) => simple-rec (simple-rec) => nil - Command: exit-recursive-edit This function exits from the innermost recursive edit (including minibuffer input). Its definition is effectively `(throw 'exit nil)'. - Command: abort-recursive-edit This function aborts the command that requested the innermost recursive edit (including minibuffer input), by signaling `quit' after exiting the recursive edit. Its definition is effectively `(throw 'exit t)'. *Note Quitting::. - Command: top-level This function exits all recursive editing levels; it does not return a value, as it jumps completely out of any computation directly back to the main command loop. - Function: recursion-depth This function returns the current depth of recursive edits. When no recursive edit is active, it returns 0. Disabling Commands ================== "Disabling a command" marks the command as requiring user confirmation before it can be executed. Disabling is used for commands which might be confusing to beginning users, to prevent them from using the commands by accident. The low-level mechanism for disabling a command is to put a non-`nil' `disabled' property on the Lisp symbol for the command. These properties are normally set up by the user's `.emacs' file with Lisp expressions such as this: (put 'upcase-region 'disabled t) For a few commands, these properties are present by default and may be removed by the `.emacs' file. If the value of the `disabled' property is a string, the message saying the command is disabled includes that string. For example: (put 'delete-region 'disabled "Text deleted this way cannot be yanked back!\n") *Note Disabling: (emacs)Disabling, for the details on what happens when a disabled command is invoked interactively. Disabling a command has no effect on calling it as a function from Lisp programs. - Command: enable-command COMMAND Allow COMMAND to be executed without special confirmation from now on, and (if the user confirms) alter the user's `.emacs' file so that this will apply to future sessions. - Command: disable-command COMMAND Require special confirmation to execute COMMAND from now on, and (if the user confirms) alter the user's `.emacs' file so that this will apply to future sessions. - Variable: disabled-command-hook When the user invokes a disabled command interactively, this normal hook is run instead of the disabled command. The hook functions can use `this-command-keys' to determine what the user typed to run the command, and thus find the command itself. *Note Hooks::. By default, `disabled-command-hook' contains a function that asks the user whether to proceed. Command History =============== The command loop keeps a history of the complex commands that have been executed, to make it convenient to repeat these commands. A "complex command" is one for which the interactive argument reading uses the minibuffer. This includes any `M-x' command, any `M-:' command, and any command whose `interactive' specification reads an argument from the minibuffer. Explicit use of the minibuffer during the execution of the command itself does not cause the command to be considered complex. - Variable: command-history This variable's value is a list of recent complex commands, each represented as a form to evaluate. It continues to accumulate all complex commands for the duration of the editing session, but when it reaches the maximum size (specified by the variable `history-length'), the oldest elements are deleted as new ones are added. command-history => ((switch-to-buffer "chistory.texi") (describe-key "^X^[") (visit-tags-table "~/emacs/src/") (find-tag "repeat-complex-command")) This history list is actually a special case of minibuffer history (*note Minibuffer History::.), with one special twist: the elements are expressions rather than strings. There are a number of commands devoted to the editing and recall of previous commands. The commands `repeat-complex-command', and `list-command-history' are described in the user manual (*note Repetition: (emacs)Repetition.). Within the minibuffer, the usual minibuffer history commands are available. Keyboard Macros =============== A "keyboard macro" is a canned sequence of input events that can be considered a command and made the definition of a key. The Lisp representation of a keyboard macro is a string or vector containing the events. Don't confuse keyboard macros with Lisp macros (*note Macros::.). - Function: execute-kbd-macro KBDMACRO &optional COUNT This function executes KBDMACRO as a sequence of events. If KBDMACRO is a string or vector, then the events in it are executed exactly as if they had been input by the user. The sequence is *not* expected to be a single key sequence; normally a keyboard macro definition consists of several key sequences concatenated. If KBDMACRO is a symbol, then its function definition is used in place of KBDMACRO. If that is another symbol, this process repeats. Eventually the result should be a string or vector. If the result is not a symbol, string, or vector, an error is signaled. The argument COUNT is a repeat count; KBDMACRO is executed that many times. If COUNT is omitted or `nil', KBDMACRO is executed once. If it is 0, KBDMACRO is executed over and over until it encounters an error or a failing search. *Note Reading One Event::, for an example of using `execute-kbd-macro'. - Variable: executing-macro This variable contains the string or vector that defines the keyboard macro that is currently executing. It is `nil' if no macro is currently executing. A command can test this variable so as to behave differently when run from an executing macro. Do not set this variable yourself. - Variable: defining-kbd-macro This variable indicates whether a keyboard macro is being defined. A command can test this variable so as to behave differently while a macro is being defined. The commands `start-kbd-macro' and `end-kbd-macro' set this variable--do not set it yourself. The variable is always local to the current terminal and cannot be buffer-local. *Note Multiple Displays::. - Variable: last-kbd-macro This variable is the definition of the most recently defined keyboard macro. Its value is a string or vector, or `nil'. The variable is always local to the current terminal and cannot be buffer-local. *Note Multiple Displays::. Keymaps ******* The bindings between input events and commands are recorded in data structures called "keymaps". Each binding in a keymap associates (or "binds") an individual event type either to another keymap or to a command. When an event type is bound to a keymap, that keymap is used to look up the next input event; this continues until a command is found. The whole process is called "key lookup". Keymap Terminology ================== A "keymap" is a table mapping event types to definitions (which can be any Lisp objects, though only certain types are meaningful for execution by the command loop). Given an event (or an event type) and a keymap, Emacs can get the event's definition. Events include characters, function keys, and mouse actions (*note Input Events::.). A sequence of input events that form a unit is called a "key sequence", or "key" for short. A sequence of one event is always a key sequence, and so are some multi-event sequences. A keymap determines a binding or definition for any key sequence. If the key sequence is a single event, its binding is the definition of the event in the keymap. The binding of a key sequence of more than one event is found by an iterative process: the binding of the first event is found, and must be a keymap; then the second event's binding is found in that keymap, and so on until all the events in the key sequence are used up. If the binding of a key sequence is a keymap, we call the key sequence a "prefix key". Otherwise, we call it a "complete key" (because no more events can be added to it). If the binding is `nil', we call the key "undefined". Examples of prefix keys are `C-c', `C-x', and `C-x 4'. Examples of defined complete keys are `X', , and `C-x 4 C-f'. Examples of undefined complete keys are `C-x C-g', and `C-c 3'. *Note Prefix Keys::, for more details. The rule for finding the binding of a key sequence assumes that the intermediate bindings (found for the events before the last) are all keymaps; if this is not so, the sequence of events does not form a unit--it is not really one key sequence. In other words, removing one or more events from the end of any valid key sequence must always yield a prefix key. For example, `C-f C-n' is not a key sequence; `C-f' is not a prefix key, so a longer sequence starting with `C-f' cannot be a key sequence. The set of possible multi-event key sequences depends on the bindings for prefix keys; therefore, it can be different for different keymaps, and can change when bindings are changed. However, a one-event sequence is always a key sequence, because it does not depend on any prefix keys for its well-formedness. At any time, several primary keymaps are "active"--that is, in use for finding key bindings. These are the "global map", which is shared by all buffers; the "local keymap", which is usually associated with a specific major mode; and zero or more "minor mode keymaps", which belong to currently enabled minor modes. (Not all minor modes have keymaps.) The local keymap bindings shadow (i.e., take precedence over) the corresponding global bindings. The minor mode keymaps shadow both local and global keymaps. *Note Active Keymaps::, for details. Format of Keymaps ================= A keymap is a list whose CAR is the symbol `keymap'. The remaining elements of the list define the key bindings of the keymap. Use the function `keymapp' (see below) to test whether an object is a keymap. Several kinds of elements may appear in a keymap, after the symbol `keymap' that begins it: `(TYPE . BINDING)' This specifies one binding, for events of type TYPE. Each ordinary binding applies to events of a particular "event type", which is always a character or a symbol. *Note Classifying Events::. `(t . BINDING)' This specifies a "default key binding"; any event not bound by other elements of the keymap is given BINDING as its binding. Default bindings allow a keymap to bind all possible event types without having to enumerate all of them. A keymap that has a default binding completely masks any lower-precedence keymap. `VECTOR' If an element of a keymap is a vector, the vector counts as bindings for all the ASCII characters, codes 0 through 127; vector element N is the binding for the character with code N. This is a compact way to record lots of bindings. A keymap with such a vector is called a "full keymap". Other keymaps are called "sparse keymaps". When a keymap contains a vector, it always defines a binding for each ASCII character, even if the vector contains `nil' for that character. Such a binding of `nil' overrides any default key binding in the keymap, for ASCII characters. However, default bindings are still meaningful for events other than ASCII characters. A binding of `nil' does *not* override lower-precedence keymaps; thus, if the local map gives a binding of `nil', Emacs uses the binding from the global map. `STRING' Aside from bindings, a keymap can also have a string as an element. This is called the "overall prompt string" and makes it possible to use the keymap as a menu. *Note Menu Keymaps::. Keymaps do not directly record bindings for the meta characters. Instead, meta characters are regarded for purposes of key lookup as sequences of two characters, the first of which is (or whatever is currently the value of `meta-prefix-char'). Thus, the key `M-a' is really represented as ` a', and its global binding is found at the slot for `a' in `esc-map' (*note Prefix Keys::.). Here as an example is the local keymap for Lisp mode, a sparse keymap. It defines bindings for and , plus `C-c C-l', `M-C-q', and `M-C-x'. lisp-mode-map => (keymap ;; (9 . lisp-indent-line) ;; (127 . backward-delete-char-untabify) (3 keymap ;; C-c C-l (12 . run-lisp)) (27 keymap ;; `M-C-q', treated as ` C-q' (17 . indent-sexp) ;; `M-C-x', treated as ` C-x' (24 . lisp-send-defun))) - Function: keymapp OBJECT This function returns `t' if OBJECT is a keymap, `nil' otherwise. More precisely, this function tests for a list whose CAR is `keymap'. (keymapp '(keymap)) => t (keymapp (current-global-map)) => t Creating Keymaps ================ Here we describe the functions for creating keymaps. - Function: make-keymap &optional PROMPT This function creates and returns a new full keymap (i.e., one containing a vector of length 128 for defining all the ASCII characters). The new keymap initially binds all ASCII characters to `nil', and does not bind any other kind of event. (make-keymap) => (keymap [nil nil nil ... nil nil]) If you specify PROMPT, that becomes the overall prompt string for the keymap. The prompt string is useful for menu keymaps (*note Menu Keymaps::.). - Function: make-sparse-keymap &optional PROMPT This function creates and returns a new sparse keymap with no entries. The new keymap does not bind any events. The argument PROMPT specifies a prompt string, as in `make-keymap'. (make-sparse-keymap) => (keymap) - Function: copy-keymap KEYMAP This function returns a copy of KEYMAP. Any keymaps that appear directly as bindings in KEYMAP are also copied recursively, and so on to any number of levels. However, recursive copying does not take place when the definition of a character is a symbol whose function definition is a keymap; the same symbol appears in the new copy. (setq map (copy-keymap (current-local-map))) => (keymap ;; (This implements meta characters.) (27 keymap (83 . center-paragraph) (115 . center-line)) (9 . tab-to-tab-stop)) (eq map (current-local-map)) => nil (equal map (current-local-map)) => t Inheritance and Keymaps ======================= A keymap can inherit the bindings of another keymap, which we call the "parent keymap". Such a keymap looks like this: (keymap BINDINGS... . PARENT-KEYMAP) The effect is that this keymap inherits all the bindings of PARENT-KEYMAP, whatever they may be at the time a key is looked up, but can add to them or override them with BINDINGS. If you change the bindings in PARENT-KEYMAP using `define-key' or other key-binding functions, these changes are visible in the inheriting keymap unless shadowed by BINDINGS. The converse is not true: if you use `define-key' to change the inheriting keymap, that affects BINDINGS, but has no effect on PARENT-KEYMAP. The proper way to construct a keymap with a parent is to use `set-keymap-parent'; if you have code that directly constructs a keymap with a parent, please convert the program to use `set-keymap-parent' instead. - Function: keymap-parent KEYMAP This returns the parent keymap of KEYMAP. If KEYMAP has no parent, `keymap-parent' returns `nil'. - Function: set-keymap-parent KEYMAP PARENT This sets the parent keymap of KEYMAP to PARENT, and returns PARENT. If PARENT is `nil', this function gives KEYMAP no parent at all. If KEYMAP has submaps (bindings for prefix keys), they too receive new parent keymaps that reflect what PARENT specifies for those prefix keys. Here is an example showing how to make a keymap that inherits from `text-mode-map': (let ((map (make-sparse-keymap))) (set-keymap-parent map text-mode-map) map) Prefix Keys =========== A "prefix key" is a key sequence whose binding is a keymap. The keymap defines what to do with key sequences that extend the prefix key. For example, `C-x' is a prefix key, and it uses a keymap that is also stored in the variable `ctl-x-map'. This keymap defines bindings for key sequences starting with `C-x'. Some of the standard Emacs prefix keys use keymaps that are also found in Lisp variables: * `esc-map' is the global keymap for the prefix key. Thus, the global definitions of all meta characters are actually found here. This map is also the function definition of `ESC-prefix'. * `help-map' is the global keymap for the `C-h' prefix key. * `mode-specific-map' is the global keymap for the prefix key `C-c'. This map is actually global, not mode-specific, but its name provides useful information about `C-c' in the output of `C-h b' (`display-bindings'), since the main use of this prefix key is for mode-specific bindings. * `ctl-x-map' is the global keymap used for the `C-x' prefix key. This map is found via the function cell of the symbol `Control-X-prefix'. * `mule-keymap' is the global keymap used for the `C-x ' prefix key. * `ctl-x-4-map' is the global keymap used for the `C-x 4' prefix key. * `ctl-x-5-map' is the global keymap used for the `C-x 5' prefix key. * `2C-mode-map' is the global keymap used for the `C-x 6' prefix key. * `vc-prefix-map' is the global keymap used for the `C-x v' prefix key. * `facemenu-keymap' is the global keymap used for the `M-g' prefix key. * The other Emacs prefix keys are `C-x @', `C-x a i', `C-x ' and ` '. They use keymaps that have no special names. The keymap binding of a prefix key is used for looking up the event that follows the prefix key. (It may instead be a symbol whose function definition is a keymap. The effect is the same, but the symbol serves as a name for the prefix key.) Thus, the binding of `C-x' is the symbol `Control-X-prefix', whose function cell holds the keymap for `C-x' commands. (The same keymap is also the value of `ctl-x-map'.) Prefix key definitions can appear in any active keymap. The definitions of `C-c', `C-x', `C-h' and as prefix keys appear in the global map, so these prefix keys are always available. Major and minor modes can redefine a key as a prefix by putting a prefix key definition for it in the local map or the minor mode's map. *Note Active Keymaps::. If a key is defined as a prefix in more than one active map, then its various definitions are in effect merged: the commands defined in the minor mode keymaps come first, followed by those in the local map's prefix definition, and then by those from the global map. In the following example, we make `C-p' a prefix key in the local keymap, in such a way that `C-p' is identical to `C-x'. Then the binding for `C-p C-f' is the function `find-file', just like `C-x C-f'. The key sequence `C-p 6' is not found in any active keymap. (use-local-map (make-sparse-keymap)) => nil (local-set-key "\C-p" ctl-x-map) => nil (key-binding "\C-p\C-f") => find-file (key-binding "\C-p6") => nil - Function: define-prefix-command SYMBOL This function prepares SYMBOL for use as a prefix key's binding: it creates a full keymap and stores it as SYMBOL's function definition. Subsequently binding a key sequence to SYMBOL will make that key sequence into a prefix key. This function also sets SYMBOL as a variable, with the keymap as its value. It returns SYMBOL. Active Keymaps ============== Emacs normally contains many keymaps; at any given time, just a few of them are "active" in that they participate in the interpretation of user input. These are the global keymap, the current buffer's local keymap, and the keymaps of any enabled minor modes. The "global keymap" holds the bindings of keys that are defined regardless of the current buffer, such as `C-f'. The variable `global-map' holds this keymap, which is always active. Each buffer may have another keymap, its "local keymap", which may contain new or overriding definitions for keys. The current buffer's local keymap is always active except when `overriding-local-map' overrides it. Text properties can specify an alternative local map for certain parts of the buffer; see *Note Special Properties::. Each minor mode can have a keymap; if it does, the keymap is active when the minor mode is enabled. The variable `overriding-local-map', if non-`nil', specifies another local keymap that overrides the buffer's local map and all the minor mode keymaps. All the active keymaps are used together to determine what command to execute when a key is entered. Emacs searches these maps one by one, in order of decreasing precedence, until it finds a binding in one of the maps. The procedure for searching a single keymap is called "key lookup"; see *Note Key Lookup::. Normally, Emacs first searches for the key in the minor mode maps, in the order specified by `minor-mode-map-alist'; if they do not supply a binding for the key, Emacs searches the local map; if that too has no binding, Emacs then searches the global map. However, if `overriding-local-map' is non-`nil', Emacs searches that map first, before the global map. Since every buffer that uses the same major mode normally uses the same local keymap, you can think of the keymap as local to the mode. A change to the local keymap of a buffer (using `local-set-key', for example) is seen also in the other buffers that share that keymap. The local keymaps that are used for Lisp mode and some other major modes exist even if they have not yet been used. These local maps are the values of variables such as `lisp-mode-map'. For most major modes, which are less frequently used, the local keymap is constructed only when the mode is used for the first time in a session. The minibuffer has local keymaps, too; they contain various completion and exit commands. *Note Intro to Minibuffers::. Emacs has other keymaps that are used in a different way--translating events within `read-key-sequence'. *Note Translating Input::. *Note Standard Keymaps::, for a list of standard keymaps. - Variable: global-map This variable contains the default global keymap that maps Emacs keyboard input to commands. The global keymap is normally this keymap. The default global keymap is a full keymap that binds `self-insert-command' to all of the printing characters. It is normal practice to change the bindings in the global map, but you should not assign this variable any value other than the keymap it starts out with. - Function: current-global-map This function returns the current global keymap. This is the same as the value of `global-map' unless you change one or the other. (current-global-map) => (keymap [set-mark-command beginning-of-line ... delete-backward-char]) - Function: current-local-map This function returns the current buffer's local keymap, or `nil' if it has none. In the following example, the keymap for the `*scratch*' buffer (using Lisp Interaction mode) is a sparse keymap in which the entry for , ASCII code 27, is another sparse keymap. (current-local-map) => (keymap (10 . eval-print-last-sexp) (9 . lisp-indent-line) (127 . backward-delete-char-untabify) (27 keymap (24 . eval-defun) (17 . indent-sexp))) - Function: current-minor-mode-maps This function returns a list of the keymaps of currently enabled minor modes. - Function: use-global-map KEYMAP This function makes KEYMAP the new current global keymap. It returns `nil'. It is very unusual to change the global keymap. - Function: use-local-map KEYMAP This function makes KEYMAP the new local keymap of the current buffer. If KEYMAP is `nil', then the buffer has no local keymap. `use-local-map' returns `nil'. Most major mode commands use this function. - Variable: minor-mode-map-alist This variable is an alist describing keymaps that may or may not be active according to the values of certain variables. Its elements look like this: (VARIABLE . KEYMAP) The keymap KEYMAP is active whenever VARIABLE has a non-`nil' value. Typically VARIABLE is the variable that enables or disables a minor mode. *Note Keymaps and Minor Modes::. Note that elements of `minor-mode-map-alist' do not have the same structure as elements of `minor-mode-alist'. The map must be the CDR of the element; a list with the map as the CADR will not do. The CADR can be either a keymap (a list) or a symbol whose function definition is a keymap. When more than one minor mode keymap is active, their order of priority is the order of `minor-mode-map-alist'. But you should design minor modes so that they don't interfere with each other. If you do this properly, the order will not matter. See *Note Keymaps and Minor Modes::, for more information about minor modes. See also `minor-mode-key-binding' (*note Functions for Key Lookup::.). - Variable: minor-mode-overriding-map-alist This variable allows major modes to override the key bindings for particular minor modes. The elements of this alist look like the elements of `minor-mode-map-alist': `(VARIABLE . KEYMAP)'. If a variable appears as an element of `minor-mode-overriding-map-alist', the map specified by that element totally replaces any map specified for the same variable in `minor-mode-map-alist'. `minor-mode-overriding-map-alist' is automatically buffer-local in all buffers. - Variable: overriding-local-map If non-`nil', this variable holds a keymap to use instead of the buffer's local keymap and instead of all the minor mode keymaps. This keymap, if any, overrides all other maps that would have been active, except for the current global map. - Variable: overriding-terminal-local-map If non-`nil', this variable holds a keymap to use instead of `overriding-local-map', the buffer's local keymap and all the minor mode keymaps. This variable is always local to the current terminal and cannot be buffer-local. *Note Multiple Displays::. It is used to implement incremental search mode. - Variable: overriding-local-map-menu-flag If this variable is non-`nil', the value of `overriding-local-map' or `overriding-terminal-local-map' can affect the display of the menu bar. The default value is `nil', so those map variables have no effect on the menu bar. Note that these two map variables do affect the execution of key sequences entered using the menu bar, even if they do not affect the menu bar display. So if a menu bar key sequence comes in, you should clear the variables before looking up and executing that key sequence. Modes that use the variables would typically do this anyway; normally they respond to events that they do not handle by "unreading" them and exiting. - Variable: special-event-map This variable holds a keymap for special events. If an event type has a binding in this keymap, then it is special, and the binding for the event is run directly by `read-event'. *Note Special Events::. Key Lookup ========== "Key lookup" is the process of finding the binding of a key sequence from a given keymap. Actual execution of the binding is not part of key lookup. Key lookup uses just the event type of each event in the key sequence; the rest of the event is ignored. In fact, a key sequence used for key lookup may designate mouse events with just their types (symbols) instead of with entire mouse events (lists). *Note Input Events::. Such a "key-sequence" is insufficient for `command-execute' to run, but it is sufficient for looking up or rebinding a key. When the key sequence consists of multiple events, key lookup processes the events sequentially: the binding of the first event is found, and must be a keymap; then the second event's binding is found in that keymap, and so on until all the events in the key sequence are used up. (The binding thus found for the last event may or may not be a keymap.) Thus, the process of key lookup is defined in terms of a simpler process for looking up a single event in a keymap. How that is done depends on the type of object associated with the event in that keymap. Let's use the term "keymap entry" to describe the value found by looking up an event type in a keymap. (This doesn't include the item string and other extra elements in menu key bindings, because `lookup-key' and other key lookup functions don't include them in the returned value.) While any Lisp object may be stored in a keymap as a keymap entry, not all make sense for key lookup. Here is a table of the meaningful kinds of keymap entries: `nil' `nil' means that the events used so far in the lookup form an undefined key. When a keymap fails to mention an event type at all, and has no default binding, that is equivalent to a binding of `nil' for that event type. COMMAND The events used so far in the lookup form a complete key, and COMMAND is its binding. *Note What Is a Function::. ARRAY The array (either a string or a vector) is a keyboard macro. The events used so far in the lookup form a complete key, and the array is its binding. See *Note Keyboard Macros::, for more information. KEYMAP The events used so far in the lookup form a prefix key. The next event of the key sequence is looked up in KEYMAP. LIST The meaning of a list depends on the types of the elements of the list. * If the CAR of LIST is the symbol `keymap', then the list is a keymap, and is treated as a keymap (see above). * If the CAR of LIST is `lambda', then the list is a lambda expression. This is presumed to be a command, and is treated as such (see above). * If the CAR of LIST is a keymap and the CDR is an event type, then this is an "indirect entry": (OTHERMAP . OTHERTYPE) When key lookup encounters an indirect entry, it looks up instead the binding of OTHERTYPE in OTHERMAP and uses that. This feature permits you to define one key as an alias for another key. For example, an entry whose CAR is the keymap called `esc-map' and whose CDR is 32 (the code for ) means, "Use the global binding of `Meta-', whatever that may be." SYMBOL The function definition of SYMBOL is used in place of SYMBOL. If that too is a symbol, then this process is repeated, any number of times. Ultimately this should lead to an object that is a keymap, a command, or a keyboard macro. A list is allowed if it is a keymap or a command, but indirect entries are not understood when found via symbols. Note that keymaps and keyboard macros (strings and vectors) are not valid functions, so a symbol with a keymap, string, or vector as its function definition is invalid as a function. It is, however, valid as a key binding. If the definition is a keyboard macro, then the symbol is also valid as an argument to `command-execute' (*note Interactive Call::.). The symbol `undefined' is worth special mention: it means to treat the key as undefined. Strictly speaking, the key is defined, and its binding is the command `undefined'; but that command does the same thing that is done automatically for an undefined key: it rings the bell (by calling `ding') but does not signal an error. `undefined' is used in local keymaps to override a global key binding and make the key "undefined" locally. A local binding of `nil' would fail to do this because it would not override the global binding. ANYTHING ELSE If any other type of object is found, the events used so far in the lookup form a complete key, and the object is its binding, but the binding is not executable as a command. In short, a keymap entry may be a keymap, a command, a keyboard macro, a symbol that leads to one of them, or an indirection or `nil'. Here is an example of a sparse keymap with two characters bound to commands and one bound to another keymap. This map is the normal value of `emacs-lisp-mode-map'. Note that 9 is the code for , 127 for , 27 for , 17 for `C-q' and 24 for `C-x'. (keymap (9 . lisp-indent-line) (127 . backward-delete-char-untabify) (27 keymap (17 . indent-sexp) (24 . eval-defun))) Functions for Key Lookup ======================== Here are the functions and variables pertaining to key lookup. - Function: lookup-key KEYMAP KEY &optional ACCEPT-DEFAULTS This function returns the definition of KEY in KEYMAP. All the other functions described in this chapter that look up keys use `lookup-key'. Here are examples: (lookup-key (current-global-map) "\C-x\C-f") => find-file (lookup-key (current-global-map) "\C-x\C-f12345") => 2 If the string or vector KEY is not a valid key sequence according to the prefix keys specified in KEYMAP, it must be "too long" and have extra events at the end that do not fit into a single key sequence. Then the value is a number, the number of events at the front of KEY that compose a complete key. If ACCEPT-DEFAULTS is non-`nil', then `lookup-key' considers default bindings as well as bindings for the specific events in KEY. Otherwise, `lookup-key' reports only bindings for the specific sequence KEY, ignoring default bindings except when you explicitly ask about them. (To do this, supply `t' as an element of KEY; see *Note Format of Keymaps::.) If KEY contains a meta character, that character is implicitly replaced by a two-character sequence: the value of `meta-prefix-char', followed by the corresponding non-meta character. Thus, the first example below is handled by conversion into the second example. (lookup-key (current-global-map) "\M-f") => forward-word (lookup-key (current-global-map) "\ef") => forward-word Unlike `read-key-sequence', this function does not modify the specified events in ways that discard information (*note Key Sequence Input::.). In particular, it does not convert letters to lower case and it does not change drag events to clicks. - Command: undefined Used in keymaps to undefine keys. It calls `ding', but does not cause an error. - Function: key-binding KEY &optional ACCEPT-DEFAULTS This function returns the binding for KEY in the current keymaps, trying all the active keymaps. The result is `nil' if KEY is undefined in the keymaps. The argument ACCEPT-DEFAULTS controls checking for default bindings, as in `lookup-key' (above). An error is signaled if KEY is not a string or a vector. (key-binding "\C-x\C-f") => find-file - Function: local-key-binding KEY &optional ACCEPT-DEFAULTS This function returns the binding for KEY in the current local keymap, or `nil' if it is undefined there. The argument ACCEPT-DEFAULTS controls checking for default bindings, as in `lookup-key' (above). - Function: global-key-binding KEY &optional ACCEPT-DEFAULTS This function returns the binding for command KEY in the current global keymap, or `nil' if it is undefined there. The argument ACCEPT-DEFAULTS controls checking for default bindings, as in `lookup-key' (above). - Function: minor-mode-key-binding KEY &optional ACCEPT-DEFAULTS This function returns a list of all the active minor mode bindings of KEY. More precisely, it returns an alist of pairs `(MODENAME . BINDING)', where MODENAME is the variable that enables the minor mode, and BINDING is KEY's binding in that mode. If KEY has no minor-mode bindings, the value is `nil'. If the first binding found is not a prefix definition (a keymap or a symbol defined as a keymap), all subsequent bindings from other minor modes are omitted, since they would be completely shadowed. Similarly, the list omits non-prefix bindings that follow prefix bindings. The argument ACCEPT-DEFAULTS controls checking for default bindings, as in `lookup-key' (above). - Variable: meta-prefix-char This variable is the meta-prefix character code. It is used when translating a meta character to a two-character sequence so it can be looked up in a keymap. For useful results, the value should be a prefix event (*note Prefix Keys::.). The default value is 27, which is the ASCII code for . As long as the value of `meta-prefix-char' remains 27, key lookup translates `M-b' into ` b', which is normally defined as the `backward-word' command. However, if you set `meta-prefix-char' to 24, the code for `C-x', then Emacs will translate `M-b' into `C-x b', whose standard binding is the `switch-to-buffer' command. Here is an illustration: meta-prefix-char ; The default value. => 27 (key-binding "\M-b") => backward-word ?\C-x ; The print representation => 24 ; of a character. (setq meta-prefix-char 24) => 24 (key-binding "\M-b") => switch-to-buffer ; Now, typing `M-b' is ; like typing `C-x b'. (setq meta-prefix-char 27) ; Avoid confusion! => 27 ; Restore the default value! Changing Key Bindings ===================== The way to rebind a key is to change its entry in a keymap. If you change a binding in the global keymap, the change is effective in all buffers (though it has no direct effect in buffers that shadow the global binding with a local one). If you change the current buffer's local map, that usually affects all buffers using the same major mode. The `global-set-key' and `local-set-key' functions are convenient interfaces for these operations (*note Key Binding Commands::.). You can also use `define-key', a more general function; then you must specify explicitly the map to change. In writing the key sequence to rebind, it is good to use the special escape sequences for control and meta characters (*note String Type::.). The syntax `\C-' means that the following character is a control character and `\M-' means that the following character is a meta character. Thus, the string `"\M-x"' is read as containing a single `M-x', `"\C-f"' is read as containing a single `C-f', and `"\M-\C-x"' and `"\C-\M-x"' are both read as containing a single `C-M-x'. You can also use this escape syntax in vectors, as well as others that aren't allowed in strings; one example is `[?\C-\H-x home]'. *Note Character Type::. The key definition and lookup functions accept an alternate syntax for event types in a key sequence that is a vector: you can use a list containing modifier names plus one base event (a character or function key name). For example, `(control ?a)' is equivalent to `?\C-a' and `(hyper control left)' is equivalent to `C-H-left'. One advantage of such lists is that the precise numeric codes for the modifier bits don't appear in compiled files. For the functions below, an error is signaled if KEYMAP is not a keymap or if KEY is not a string or vector representing a key sequence. You can use event types (symbols) as shorthand for events that are lists. - Function: define-key KEYMAP KEY BINDING This function sets the binding for KEY in KEYMAP. (If KEY is more than one event long, the change is actually made in another keymap reached from KEYMAP.) The argument BINDING can be any Lisp object, but only certain types are meaningful. (For a list of meaningful types, see *Note Key Lookup::.) The value returned by `define-key' is BINDING. Every prefix of KEY must be a prefix key (i.e., bound to a keymap) or undefined; otherwise an error is signaled. If some prefix of KEY is undefined, then `define-key' defines it as a prefix key so that the rest of KEY can be defined as specified. If there was previously no binding for KEY in KEYMAP, the new binding is added at the beginning of KEYMAP. The order of bindings in a keymap makes no difference in most cases, but it does matter for menu keymaps (*note Menu Keymaps::.). Here is an example that creates a sparse keymap and makes a number of bindings in it: (setq map (make-sparse-keymap)) => (keymap) (define-key map "\C-f" 'forward-char) => forward-char map => (keymap (6 . forward-char)) ;; Build sparse submap for `C-x' and bind `f' in that. (define-key map "\C-xf" 'forward-word) => forward-word map => (keymap (24 keymap ; C-x (102 . forward-word)) ; f (6 . forward-char)) ; C-f ;; Bind `C-p' to the `ctl-x-map'. (define-key map "\C-p" ctl-x-map) ;; `ctl-x-map' => [nil ... find-file ... backward-kill-sentence] ;; Bind `C-f' to `foo' in the `ctl-x-map'. (define-key map "\C-p\C-f" 'foo) => 'foo map => (keymap ; Note `foo' in `ctl-x-map'. (16 keymap [nil ... foo ... backward-kill-sentence]) (24 keymap (102 . forward-word)) (6 . forward-char)) Note that storing a new binding for `C-p C-f' actually works by changing an entry in `ctl-x-map', and this has the effect of changing the bindings of both `C-p C-f' and `C-x C-f' in the default global map. - Function: substitute-key-definition OLDDEF NEWDEF KEYMAP &optional OLDMAP This function replaces OLDDEF with NEWDEF for any keys in KEYMAP that were bound to OLDDEF. In other words, OLDDEF is replaced with NEWDEF wherever it appears. The function returns `nil'. For example, this redefines `C-x C-f', if you do it in an Emacs with standard bindings: (substitute-key-definition 'find-file 'find-file-read-only (current-global-map)) If OLDMAP is non-`nil', then its bindings determine which keys to rebind. The rebindings still happen in KEYMAP, not in OLDMAP. Thus, you can change one map under the control of the bindings in another. For example, (substitute-key-definition 'delete-backward-char 'my-funny-delete my-map global-map) puts the special deletion command in `my-map' for whichever keys are globally bound to the standard deletion command. Here is an example showing a keymap before and after substitution: (setq map '(keymap (?1 . olddef-1) (?2 . olddef-2) (?3 . olddef-1))) => (keymap (49 . olddef-1) (50 . olddef-2) (51 . olddef-1)) (substitute-key-definition 'olddef-1 'newdef map) => nil map => (keymap (49 . newdef) (50 . olddef-2) (51 . newdef)) - Function: suppress-keymap KEYMAP &optional NODIGITS This function changes the contents of the full keymap KEYMAP by making all the printing characters undefined. More precisely, it binds them to the command `undefined'. This makes ordinary insertion of text impossible. `suppress-keymap' returns `nil'. If NODIGITS is `nil', then `suppress-keymap' defines digits to run `digit-argument', and `-' to run `negative-argument'. Otherwise it makes them undefined like the rest of the printing characters. The `suppress-keymap' function does not make it impossible to modify a buffer, as it does not suppress commands such as `yank' and `quoted-insert'. To prevent any modification of a buffer, make it read-only (*note Read Only Buffers::.). Since this function modifies KEYMAP, you would normally use it on a newly created keymap. Operating on an existing keymap that is used for some other purpose is likely to cause trouble; for example, suppressing `global-map' would make it impossible to use most of Emacs. Most often, `suppress-keymap' is used to initialize local keymaps of modes such as Rmail and Dired where insertion of text is not desirable and the buffer is read-only. Here is an example taken from the file `emacs/lisp/dired.el', showing how the local keymap for Dired mode is set up: (setq dired-mode-map (make-keymap)) (suppress-keymap dired-mode-map) (define-key dired-mode-map "r" 'dired-rename-file) (define-key dired-mode-map "\C-d" 'dired-flag-file-deleted) (define-key dired-mode-map "d" 'dired-flag-file-deleted) (define-key dired-mode-map "v" 'dired-view-file) (define-key dired-mode-map "e" 'dired-find-file) (define-key dired-mode-map "f" 'dired-find-file) ... Commands for Binding Keys ========================= This section describes some convenient interactive interfaces for changing key bindings. They work by calling `define-key'. People often use `global-set-key' in their `.emacs' file for simple customization. For example, (global-set-key "\C-x\C-\\" 'next-line) or (global-set-key [?\C-x ?\C-\\] 'next-line) or (global-set-key [(control ?x) (control ?\\)] 'next-line) redefines `C-x C-\' to move down a line. (global-set-key [M-mouse-1] 'mouse-set-point) redefines the first (leftmost) mouse button, typed with the Meta key, to set point where you click. - Command: global-set-key KEY DEFINITION This function sets the binding of KEY in the current global map to DEFINITION. (global-set-key KEY DEFINITION) == (define-key (current-global-map) KEY DEFINITION) - Command: global-unset-key KEY This function removes the binding of KEY from the current global map. One use of this function is in preparation for defining a longer key that uses KEY as a prefix--which would not be allowed if KEY has a non-prefix binding. For example: (global-unset-key "\C-l") => nil (global-set-key "\C-l\C-l" 'redraw-display) => nil This function is implemented simply using `define-key': (global-unset-key KEY) == (define-key (current-global-map) KEY nil) - Command: local-set-key KEY DEFINITION This function sets the binding of KEY in the current local keymap to DEFINITION. (local-set-key KEY DEFINITION) == (define-key (current-local-map) KEY DEFINITION) - Command: local-unset-key KEY This function removes the binding of KEY from the current local map. (local-unset-key KEY) == (define-key (current-local-map) KEY nil) Scanning Keymaps ================ This section describes functions used to scan all the current keymaps for the sake of printing help information. - Function: accessible-keymaps KEYMAP &optional PREFIX This function returns a list of all the keymaps that can be reached (via zero or more prefix keys) from KEYMAP. The value is an association list with elements of the form `(KEY . MAP)', where KEY is a prefix key whose definition in KEYMAP is MAP. The elements of the alist are ordered so that the KEY increases in length. The first element is always `("" . KEYMAP)', because the specified keymap is accessible from itself with a prefix of no events. If PREFIX is given, it should be a prefix key sequence; then `accessible-keymaps' includes only the submaps whose prefixes start with PREFIX. These elements look just as they do in the value of `(accessible-keymaps)'; the only difference is that some elements are omitted. In the example below, the returned alist indicates that the key , which is displayed as `^[', is a prefix key whose definition is the sparse keymap `(keymap (83 . center-paragraph) (115 . foo))'. (accessible-keymaps (current-local-map)) =>(("" keymap (27 keymap ; Note this keymap for is repeated below. (83 . center-paragraph) (115 . center-line)) (9 . tab-to-tab-stop)) ("^[" keymap (83 . center-paragraph) (115 . foo))) In the following example, `C-h' is a prefix key that uses a sparse keymap starting with `(keymap (118 . describe-variable)...)'. Another prefix, `C-x 4', uses a keymap which is also the value of the variable `ctl-x-4-map'. The event `mode-line' is one of several dummy events used as prefixes for mouse actions in special parts of a window. (accessible-keymaps (current-global-map)) => (("" keymap [set-mark-command beginning-of-line ... delete-backward-char]) ("^H" keymap (118 . describe-variable) ... (8 . help-for-help)) ("^X" keymap [x-flush-mouse-queue ... backward-kill-sentence]) ("^[" keymap [mark-sexp backward-sexp ... backward-kill-word]) ("^X4" keymap (15 . display-buffer) ...) ([mode-line] keymap (S-mouse-2 . mouse-split-window-horizontally) ...)) These are not all the keymaps you would see in actuality. - Function: where-is-internal COMMAND &optional KEYMAP FIRSTONLY NOINDIRECT This function is a subroutine used by the `where-is' command (*note Help: (emacs)Help.). It returns a list of key sequences (of any length) that are bound to COMMAND in a set of keymaps. The argument COMMAND can be any object; it is compared with all keymap entries using `eq'. If KEYMAP is `nil', then the maps used are the current active keymaps, disregarding `overriding-local-map' (that is, pretending its value is `nil'). If KEYMAP is non-`nil', then the maps searched are KEYMAP and the global keymap. Usually it's best to use `overriding-local-map' as the expression for KEYMAP. Then `where-is-internal' searches precisely the keymaps that are active. To search only the global map, pass `(keymap)' (an empty keymap) as KEYMAP. If FIRSTONLY is `non-ascii', then the value is a single string representing the first key sequence found, rather than a list of all possible key sequences. If FIRSTONLY is `t', then the value is the first key sequence, except that key sequences consisting entirely of ASCII characters (or meta variants of ASCII characters) are preferred to all other key sequences. If NOINDIRECT is non-`nil', `where-is-internal' doesn't follow indirect keymap bindings. This makes it possible to search for an indirect definition itself. (where-is-internal 'describe-function) => ("\^hf" "\^hd") - Command: describe-bindings &optional PREFIX This function creates a listing of all current key bindings, and displays it in a buffer named `*Help*'. The text is grouped by modes--minor modes first, then the major mode, then global bindings. If PREFIX is non-`nil', it should be a prefix key; then the listing includes only keys that start with PREFIX. The listing describes meta characters as followed by the corresponding non-meta character. When several characters with consecutive ASCII codes have the same definition, they are shown together, as `FIRSTCHAR..LASTCHAR'. In this instance, you need to know the ASCII codes to understand which characters this means. For example, in the default global map, the characters ` .. ~' are described by a single line. is ASCII 32, `~' is ASCII 126, and the characters between them include all the normal printing characters, (e.g., letters, digits, punctuation, etc.); all these characters are bound to `self-insert-command'. Menu Keymaps ============ A keymap can define a menu as well as bindings for keyboard keys and mouse button. Menus are usually actuated with the mouse, but they can work with the keyboard also. Defining Menus -------------- A keymap is suitable for menu use if it has an "overall prompt string", which is a string that appears as an element of the keymap. (*Note Format of Keymaps::.) The string should describe the purpose of the menu. The easiest way to construct a keymap with a prompt string is to specify the string as an argument when you call `make-keymap' or `make-sparse-keymap' (*note Creating Keymaps::.). The order of items in the menu is the same as the order of bindings in the keymap. Since `define-key' puts new bindings at the front, you should define the menu items starting at the bottom of the menu and moving to the top, if you care about the order. When you add an item to an existing menu, you can specify its position in the menu using `define-key-after' (*note Modifying Menus::.). Simple Menu Items ................. The simpler and older way to define a menu keymap binding looks like this: (ITEM-STRING . REAL-BINDING) The CAR, ITEM-STRING, is the string to be displayed in the menu. It should be short--preferably one to three words. It should describe the action of the command it corresponds to. You can also supply a second string, called the help string, as follows: (ITEM-STRING HELP-STRING . REAL-BINDING) Currently Emacs does not actually use HELP-STRING; it knows only how to ignore HELP-STRING in order to extract REAL-BINDING. In the future we may use HELP-STRING as extended documentation for the menu item, available on request. As far as `define-key' is concerned, ITEM-STRING and HELP-STRING are part of the event's binding. However, `lookup-key' returns just REAL-BINDING, and only REAL-BINDING is used for executing the key. If REAL-BINDING is `nil', then ITEM-STRING appears in the menu but cannot be selected. If REAL-BINDING is a symbol and has a non-`nil' `menu-enable' property, that property is an expression that controls whether the menu item is enabled. Every time the keymap is used to display a menu, Emacs evaluates the expression, and it enables the menu item only if the expression's value is non-`nil'. When a menu item is disabled, it is displayed in a "fuzzy" fashion, and cannot be selected. The menu bar does not recalculate which items are enabled every time you look at a menu. This is because the X toolkit requires the whole tree of menus in advance. To force recalculation of the menu bar, call `force-mode-line-update' (*note Mode Line Format::.). You've probably noticed that menu items show the equivalent keyboard key sequence (if any) to invoke the same command. To save time on recalculation, menu display caches this information in a sublist in the binding, like this: (ITEM-STRING [HELP-STRING] (KEY-BINDING-DATA) . REAL-BINDING) Don't put these sublists in the menu item yourself; menu display calculates them automatically. Don't mention keyboard equivalents in the item strings themselves, since that is redundant. Extended Menu Items ................... An extended-format menu item is a more flexible and also cleaner alternative to the simple format. It consists of a list that starts with the symbol `menu-item'. To define a non-selectable string, the item looks like this: (menu-item ITEM-NAME) where a string consisting of two or more dashes specifies a separator line. To define a real menu item which can be selected, the extended format item looks like this: (menu-item ITEM-NAME REAL-BINDING . ITEM-PROPERTY-LIST) Here, ITEM-NAME is an expression which evaluates to the menu item string. Thus, the string need not be a constant. The third element, REAL-BINDING, is the command to execute. The tail of the list, ITEM-PROPERTY-LIST, has the form of a property list which contains other information. Here is a table of the properties that are supported: `:enable FORM' The result of evaluating FORM determines whether the item is enabled (non-`nil' means yes). `:visible FORM' The result of evaluating FORM determines whether the item should actually appear in the menu (non-`nil' means yes). If the item does not appear, then the menu is displayed as if this item were not defined at all. `:help HELP' The value of this property, HELP, is the extra help string (not currently used by Emacs). `:button (TYPE . SELECTED)' This property provides a way to define radio buttons and toggle buttons. The CAR, TYPE, says which: is should be `:toggle' or `:radio'. The CDR, SELECTED, should be a form; the result of evaluating it says whether this button is currently selected. A "toggle" is a menu item which is labeled as either "on" or "off" according to the value of SELECTED. The command itself should toggle SELECTED, setting it to `t' if it is `nil', and to `nil' if it is `t'. Here is how the menu item to toggle the `debug-on-error' flag is defined: (menu-item "Debug on Error" toggle-debug-on-error :button (:toggle . (and (boundp 'debug-on-error) debug-on-error)) This works because `toggle-debug-on-error' is defined as a command which toggles the variable `debug-on-error'. "Radio buttons" are a group of menu items, in which at any time one and only one is "selected." There should be a variable whose value says which one is selected at any time. The SELECTED form for each radio button in the group should check whether the variable has the right value for selecting that button. Clicking on the button should set the variable so that the button you clicked on becomes selected. `:key-sequence KEY-SEQUENCE' This property specifies which key sequence is likely to be bound to the same command invoked by this menu item. If you specify the right key sequence, that makes preparing the menu for display run much faster. If you specify the wrong key sequence, it has no effect; before Emacs displays KEY-SEQUENCE in the menu, it verifies that KEY-SEQUENCE is really equivalent to this menu item. `:key-sequence nil' This property indicates that there is normally no key binding which is equivalent to this menu item. Using this property saves time in preparing the menu for display, because Emacs does not need to search the keymaps for a keyboard equivalent for this menu item. However, if the user has rebound this item's definition to a key sequence, Emacs ignores the `:keys' property and finds the keyboard equivalent anyway. `:keys STRING' This property specifies that STRING is the string to display as the keyboard equivalent for this menu item. You can use the `\\[...]' documentation construct in STRING. `:filter FILTER-FN' This property provides a way to compute the menu item dynamically. The property value FILTER-FN should be a function of one argument; when it is called, its argument will be REAL-BINDING. The function should return the binding to use instead. Alias Menu Items ................ Sometimes it is useful to make menu items that use the "same" command but with different enable conditions. The best way to do this in Emacs now is with extended menu items; before that feature existed, it could be done by defining alias commands and using them in menu items. Here's an example that makes two aliases for `toggle-read-only' and gives them different enable conditions: (defalias 'make-read-only 'toggle-read-only) (put 'make-read-only 'menu-enable '(not buffer-read-only)) (defalias 'make-writable 'toggle-read-only) (put 'make-writable 'menu-enable 'buffer-read-only) When using aliases in menus, often it is useful to display the equivalent key bindings for the "real" command name, not the aliases (which typically don't have any key bindings except for the menu itself). To request this, give the alias symbol a non-`nil' `menu-alias' property. Thus, (put 'make-read-only 'menu-alias t) (put 'make-writable 'menu-alias t) causes menu items for `make-read-only' and `make-writable' to show the keyboard bindings for `toggle-read-only'. Menus and the Mouse ------------------- The usual way to make a menu keymap produce a menu is to make it the definition of a prefix key. (A Lisp program can explicitly pop up a menu and receive the user's choice--see *Note Pop-Up Menus::.) If the prefix key ends with a mouse event, Emacs handles the menu keymap by popping up a visible menu, so that the user can select a choice with the mouse. When the user clicks on a menu item, the event generated is whatever character or symbol has the binding that brought about that menu item. (A menu item may generate a series of events if the menu has multiple levels or comes from the menu bar.) It's often best to use a button-down event to trigger the menu. Then the user can select a menu item by releasing the button. A single keymap can appear as multiple menu panes, if you explicitly arrange for this. The way to do this is to make a keymap for each pane, then create a binding for each of those maps in the main keymap of the menu. Give each of these bindings an item string that starts with `@'. The rest of the item string becomes the name of the pane. See the file `lisp/mouse.el' for an example of this. Any ordinary bindings with `@'-less item strings are grouped into one pane, which appears along with the other panes explicitly created for the submaps. X toolkit menus don't have panes; instead, they can have submenus. Every nested keymap becomes a submenu, whether the item string starts with `@' or not. In a toolkit version of Emacs, the only thing special about `@' at the beginning of an item string is that the `@' doesn't appear in the menu item. You can also produce multiple panes or submenus from separate keymaps. The full definition of a prefix key always comes from merging the definitions supplied by the various active keymaps (minor mode, local, and global). When more than one of these keymaps is a menu, each of them makes a separate pane or panes (when Emacs does not use an X-toolkit) or a separate submenu (when using an X-toolkit). *Note Active Keymaps::. Menus and the Keyboard ---------------------- When a prefix key ending with a keyboard event (a character or function key) has a definition that is a menu keymap, the user can use the keyboard to choose a menu item. Emacs displays the menu alternatives (the item strings of the bindings) in the echo area. If they don't all fit at once, the user can type to see the next line of alternatives. Successive uses of eventually get to the end of the menu and then cycle around to the beginning. (The variable `menu-prompt-more-char' specifies which character is used for this; is the default.) When the user has found the desired alternative from the menu, he or she should type the corresponding character--the one whose binding is that alternative. This way of using menus in an Emacs-like editor was inspired by the Hierarkey system. - Variable: menu-prompt-more-char This variable specifies the character to use to ask to see the next line of a menu. Its initial value is 32, the code for . Menu Example ------------ Here is a complete example of defining a menu keymap. It is the definition of the `Print' submenu in the `Tools' menu in the menu bar, and it uses the simple menu item format (*note Simple Menu Items::.). First we create the keymap, and give it a name: (defvar menu-bar-print-menu (make-sparse-keymap "Print")) Next we define the menu items: (define-key menu-bar-print-menu [ps-print-region] '("Postscript Print Region" . ps-print-region-with-faces)) (define-key menu-bar-print-menu [ps-print-buffer] '("Postscript Print Buffer" . ps-print-buffer-with-faces)) (define-key menu-bar-print-menu [separator-ps-print] '("--")) (define-key menu-bar-print-menu [print-region] '("Print Region" . print-region)) (define-key menu-bar-print-menu [print-buffer] '("Print Buffer" . print-buffer)) Note the symbols which the bindings are "made for"; these appear inside square brackets, in the key sequence being defined. In some cases, this symbol is the same as the command name; sometimes it is different. These symbols are treated as "function keys", but they are not real function keys on the keyboard. They do not affect the functioning of the menu itself, but they are "echoed" in the echo area when the user selects from the menu, and they appear in the output of `where-is' and `apropos'. The binding whose definition is `("--")' is a separator line. Like a real menu item, the separator has a key symbol, in this case `separator-ps-print'. If one menu has two separators, they must have two different key symbols. Here is code to define enable conditions for two of the commands in the menu: (put 'print-region 'menu-enable 'mark-active) (put 'ps-print-region-with-faces 'menu-enable 'mark-active) Here is how we make this menu appear as an item in the parent menu: (define-key menu-bar-tools-menu [print] (cons "Print" menu-bar-print-menu)) Note that this incorporates the submenu keymap, which is the value of the variable `menu-bar-print-menu', rather than the symbol `menu-bar-print-menu' itself. Using that symbol in the parent menu item would be meaningless because `menu-bar-print-menu' is not a command. If you wanted to attach the same print menu to a mouse click, you can do it this way: (define-key global-map [C-S-down-mouse-1] menu-bar-print-menu) We could equally well use an extended menu item (*note Extended Menu Items::.) for `print-region', like this: (define-key menu-bar-print-menu [print-region] '(menu-item "Print Region" print-region :enable (mark-active))) With the extended menu item, the enable condition is specified inside the menu item itself. If we wanted to make this item disappear from the menu entirely when the mark is inactive, we could do it this way: (define-key menu-bar-print-menu [print-region] '(menu-item "Print Region" print-region :visible (mark-active))) The Menu Bar ------------ Most window systems allow each frame to have a "menu bar"--a permanently displayed menu stretching horizontally across the top of the frame. The items of the menu bar are the subcommands of the fake "function key" `menu-bar', as defined by all the active keymaps. To add an item to the menu bar, invent a fake "function key" of your own (let's call it KEY), and make a binding for the key sequence `[menu-bar KEY]'. Most often, the binding is a menu keymap, so that pressing a button on the menu bar item leads to another menu. When more than one active keymap defines the same fake function key for the menu bar, the item appears just once. If the user clicks on that menu bar item, it brings up a single, combined menu containing all the subcommands of that item--the global subcommands, the local subcommands, and the minor mode subcommands. The variable `overriding-local-map' is normally ignored when determining the menu bar contents. That is, the menu bar is computed from the keymaps that would be active if `overriding-local-map' were `nil'. *Note Active Keymaps::. In order for a frame to display a menu bar, its `menu-bar-lines' parameter must be greater than zero. Emacs uses just one line for the menu bar itself; if you specify more than one line, the other lines serve to separate the menu bar from the windows in the frame. We recommend 1 or 2 as the value of `menu-bar-lines'. *Note Window Frame Parameters::. Here's an example of setting up a menu bar item: (modify-frame-parameters (selected-frame) '((menu-bar-lines . 2))) ;; Make a menu keymap (with a prompt string) ;; and make it the menu bar item's definition. (define-key global-map [menu-bar words] (cons "Words" (make-sparse-keymap "Words"))) ;; Define specific subcommands in this menu. (define-key global-map [menu-bar words forward] '("Forward word" . forward-word)) (define-key global-map [menu-bar words backward] '("Backward word" . backward-word)) A local keymap can cancel a menu bar item made by the global keymap by rebinding the same fake function key with `undefined' as the binding. For example, this is how Dired suppresses the `Edit' menu bar item: (define-key dired-mode-map [menu-bar edit] 'undefined) `edit' is the fake function key used by the global map for the `Edit' menu bar item. The main reason to suppress a global menu bar item is to regain space for mode-specific items. - Variable: menu-bar-final-items Normally the menu bar shows global items followed by items defined by the local maps. This variable holds a list of fake function keys for items to display at the end of the menu bar rather than in normal sequence. The default value is `(help-menu)'; thus, the `Help' menu item normally appears at the end of the menu bar, following local menu items. - Variable: menu-bar-update-hook This normal hook is run whenever the user clicks on the menu bar, before displaying a submenu. You can use it to update submenus whose contents should vary. Modifying Menus --------------- When you insert a new item in an existing menu, you probably want to put it in a particular place among the menu's existing items. If you use `define-key' to add the item, it normally goes at the front of the menu. To put it elsewhere in the menu, use `define-key-after': - Function: define-key-after MAP KEY BINDING AFTER Define a binding in MAP for KEY, with value BINDING, just like `define-key', but position the binding in MAP after the binding for the event AFTER. The argument KEY should be of length one--a vector or string with just one element. But AFTER should be a single event type--a symbol or a character, not a sequence. The new binding goes after the binding for AFTER. If AFTER is `t', then the new binding goes last, at the end of the keymap. Here is an example: (define-key-after my-menu [drink] '("Drink" . drink-command) 'eat) makes a binding for the fake function key and puts it right after the binding for . Here is how to insert an item called `Work' in the `Signals' menu of Shell mode, after the item `break': (define-key-after (lookup-key shell-mode-map [menu-bar signals]) [work] '("Work" . work-command) 'break) Major and Minor Modes ********************* A "mode" is a set of definitions that customize Emacs and can be turned on and off while you edit. There are two varieties of modes: "major modes", which are mutually exclusive and used for editing particular kinds of text, and "minor modes", which provide features that users can enable individually. This chapter describes how to write both major and minor modes, how to indicate them in the mode line, and how they run hooks supplied by the user. For related topics such as keymaps and syntax tables, see *Note Keymaps::, and *Note Syntax Tables::. Major Modes =========== Major modes specialize Emacs for editing particular kinds of text. Each buffer has only one major mode at a time. The least specialized major mode is called "Fundamental mode". This mode has no mode-specific definitions or variable settings, so each Emacs command behaves in its default manner, and each option is in its default state. All other major modes redefine various keys and options. For example, Lisp Interaction mode provides special key bindings for `C-j' (`eval-print-last-sexp'), (`lisp-indent-line'), and other keys. When you need to write several editing commands to help you perform a specialized editing task, creating a new major mode is usually a good idea. In practice, writing a major mode is easy (in contrast to writing a minor mode, which is often difficult). If the new mode is similar to an old one, it is often unwise to modify the old one to serve two purposes, since it may become harder to use and maintain. Instead, copy and rename an existing major mode definition and alter the copy--or define a "derived mode" (*note Derived Modes::.). For example, Rmail Edit mode, which is in `emacs/lisp/rmailedit.el', is a major mode that is very similar to Text mode except that it provides three additional commands. Its definition is distinct from that of Text mode, but was derived from it. Rmail Edit mode offers an example of changing the major mode temporarily for a buffer, so it can be edited in a different way (with ordinary Emacs commands rather than Rmail commands). In such cases, the temporary major mode usually has a command to switch back to the buffer's usual mode (Rmail mode, in this case). You might be tempted to present the temporary redefinitions inside a recursive edit and restore the usual ones when the user exits; but this is a bad idea because it constrains the user's options when it is done in more than one buffer: recursive edits must be exited most-recently-entered first. Using an alternative major mode avoids this limitation. *Note Recursive Editing::. The standard GNU Emacs Lisp library directory contains the code for several major modes, in files such as `text-mode.el', `texinfo.el', `lisp-mode.el', `c-mode.el', and `rmail.el'. You can study these libraries to see how modes are written. Text mode is perhaps the simplest major mode aside from Fundamental mode. Rmail mode is a complicated and specialized mode. Major Mode Conventions ---------------------- The code for existing major modes follows various coding conventions, including conventions for local keymap and syntax table initialization, global names, and hooks. Please follow these conventions when you define a new major mode: * Define a command whose name ends in `-mode', with no arguments, that switches to the new mode in the current buffer. This command should set up the keymap, syntax table, and buffer-local variables in an existing buffer, without changing the buffer's contents. * Write a documentation string for this command that describes the special commands available in this mode. `C-h m' (`describe-mode') in your mode will display this string. The documentation string may include the special documentation substrings, `\[COMMAND]', `\{KEYMAP}', and `\', that enable the documentation to adapt automatically to the user's own key bindings. *Note Keys in Documentation::. * The major mode command should start by calling `kill-all-local-variables'. This is what gets rid of the buffer-local variables of the major mode previously in effect. * The major mode command should set the variable `major-mode' to the major mode command symbol. This is how `describe-mode' discovers which documentation to print. * The major mode command should set the variable `mode-name' to the "pretty" name of the mode, as a string. This string appears in the mode line. * Since all global names are in the same name space, all the global variables, constants, and functions that are part of the mode should have names that start with the major mode name (or with an abbreviation of it if the name is long). *Note Coding Conventions::. * The major mode should usually have its own keymap, which is used as the local keymap in all buffers in that mode. The major mode command should call `use-local-map' to install this local map. *Note Active Keymaps::, for more information. This keymap should be stored permanently in a global variable named `MODENAME-mode-map'. Normally the library that defines the mode sets this variable. *Note Tips for Defining::, for advice about how to write the code to set up the mode's keymap variable. * The key sequences bound in a major mode keymap should usually start with `C-c', followed by a control character, a digit, or `{', `}', `<', `>', `:' or `;'. The other punctuation characters are reserved for minor modes, and ordinary letters are reserved for users. It is reasonable for a major mode to rebind a key sequence with a standard meaning, if it implements a command that does "the same job" in a way that fits the major mode better. For example, a major mode for editing a programming language might redefine `C-M-a' to "move to the beginning of a function" in a way that works better for that language. Major modes such as Dired or Rmail that do not allow self-insertion of text can reasonably redefine letters and other printing characters as editing commands. Dired and Rmail both do this. * The mode may have its own syntax table or may share one with other related modes. If it has its own syntax table, it should store this in a variable named `MODENAME-mode-syntax-table'. *Note Syntax Tables::. * If the mode handles a language that has a syntax for comments, it should set the variables that define the comment syntax. *Note Options Controlling Comments: (emacs)Options for Comments. * The mode may have its own abbrev table or may share one with other related modes. If it has its own abbrev table, it should store this in a variable named `MODENAME-mode-abbrev-table'. *Note Abbrev Tables::. * The mode should specify how to do highlighting for Font Lock mode, by setting up a buffer-local value for the variable `font-lock-defaults' (*note Font Lock Mode::.). * The mode should specify how Imenu should find the definitions or sections of a buffer, by setting up a buffer-local value for the variable `imenu-generic-expression' or `imenu-create-index-function' (*note Imenu::.). * Use `defvar' or `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.) * To make a buffer-local binding for an Emacs customization variable, use `make-local-variable' in the major mode command, not `make-variable-buffer-local'. The latter function would make the variable local to every buffer in which it is subsequently set, which would affect buffers that do not use this mode. It is undesirable for a mode to have such global effects. *Note Buffer-Local Variables::. It's OK to use `make-variable-buffer-local', if you wish, for a variable used only within a single Lisp package. * Each major mode should have a "mode hook" named `MODENAME-mode-hook'. The major mode command should run that hook, with `run-hooks', as the very last thing it does. *Note Hooks::. * The major mode command may also run the hooks of some more basic modes. For example, `indented-text-mode' runs `text-mode-hook' as well as `indented-text-mode-hook'. It may run these other hooks immediately before the mode's own hook (that is, after everything else), or it may run them earlier. * If something special should be done if the user switches a buffer from this mode to any other major mode, this mode can set up a buffer-local value for `change-major-mode-hook' (*note Creating Buffer-Local::.). * If this mode is appropriate only for specially-prepared text, then the major mode command symbol should have a property named `mode-class' with value `special', put on as follows: (put 'funny-mode 'mode-class 'special) This tells Emacs that new buffers created while the current buffer has Funny mode should not inherit Funny mode. Modes such as Dired, Rmail, and Buffer List use this feature. * If you want to make the new mode the default for files with certain recognizable names, add an element to `auto-mode-alist' to select the mode for those file names. If you define the mode command to autoload, you should add this element in the same file that calls `autoload'. Otherwise, it is sufficient to add the element in the file that contains the mode definition. *Note Auto Major Mode::. * In the documentation, you should provide a sample `autoload' form and an example of how to add to `auto-mode-alist', that users can include in their `.emacs' files. * 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. Major Mode Examples ------------------- Text mode is perhaps the simplest mode besides Fundamental mode. Here are excerpts from `text-mode.el' that illustrate many of the conventions listed above: ;; Create mode-specific tables. (defvar text-mode-syntax-table nil "Syntax table used while in text mode.") (if text-mode-syntax-table () ; Do not change the table if it is already set up. (setq text-mode-syntax-table (make-syntax-table)) (modify-syntax-entry ?\" ". " text-mode-syntax-table) (modify-syntax-entry ?\\ ". " text-mode-syntax-table) (modify-syntax-entry ?' "w " text-mode-syntax-table)) (defvar text-mode-abbrev-table nil "Abbrev table used while in text mode.") (define-abbrev-table 'text-mode-abbrev-table ()) (defvar text-mode-map nil) ; Create a mode-specific keymap. (if text-mode-map () ; Do not change the keymap if it is already set up. (setq text-mode-map (make-sparse-keymap)) (define-key text-mode-map "\t" 'indent-relative) (define-key text-mode-map "\es" 'center-line) (define-key text-mode-map "\eS" 'center-paragraph)) Here is the complete major mode function definition for Text mode: (defun text-mode () "Major mode for editing text intended for humans to read.... Special commands: \\{text-mode-map} Turning on text-mode runs the hook `text-mode-hook'." (interactive) (kill-all-local-variables) (use-local-map text-mode-map) (setq local-abbrev-table text-mode-abbrev-table) (set-syntax-table text-mode-syntax-table) (make-local-variable 'paragraph-start) (setq paragraph-start (concat "[ \t]*$\\|" page-delimiter)) (make-local-variable 'paragraph-separate) (setq paragraph-separate paragraph-start) (setq mode-name "Text") (setq major-mode 'text-mode) (run-hooks 'text-mode-hook)) ; Finally, this permits the user to ; customize the mode with a hook. The three Lisp modes (Lisp mode, Emacs Lisp mode, and Lisp Interaction mode) have more features than Text mode and the code is correspondingly more complicated. Here are excerpts from `lisp-mode.el' that illustrate how these modes are written. ;; Create mode-specific table variables. (defvar lisp-mode-syntax-table nil "") (defvar emacs-lisp-mode-syntax-table nil "") (defvar lisp-mode-abbrev-table nil "") (if (not emacs-lisp-mode-syntax-table) ; Do not change the table ; if it is already set. (let ((i 0)) (setq emacs-lisp-mode-syntax-table (make-syntax-table)) ;; Set syntax of chars up to 0 to class of chars that are ;; part of symbol names but not words. ;; (The number 0 is `48' in the ASCII character set.) (while (< i ?0) (modify-syntax-entry i "_ " emacs-lisp-mode-syntax-table) (setq i (1+ i))) ... ;; Set the syntax for other characters. (modify-syntax-entry ? " " emacs-lisp-mode-syntax-table) (modify-syntax-entry ?\t " " emacs-lisp-mode-syntax-table) ... (modify-syntax-entry ?\( "() " emacs-lisp-mode-syntax-table) (modify-syntax-entry ?\) ")( " emacs-lisp-mode-syntax-table) ...)) ;; Create an abbrev table for lisp-mode. (define-abbrev-table 'lisp-mode-abbrev-table ()) Much code is shared among the three Lisp modes. The following function sets various variables; it is called by each of the major Lisp mode functions: (defun lisp-mode-variables (lisp-syntax) (cond (lisp-syntax (set-syntax-table lisp-mode-syntax-table))) (setq local-abbrev-table lisp-mode-abbrev-table) ... Functions such as `forward-paragraph' use the value of the `paragraph-start' variable. Since Lisp code is different from ordinary text, the `paragraph-start' variable needs to be set specially to handle Lisp. Also, comments are indented in a special fashion in Lisp and the Lisp modes need their own mode-specific `comment-indent-function'. The code to set these variables is the rest of `lisp-mode-variables'. (make-local-variable 'paragraph-start) (setq paragraph-start (concat page-delimiter "\\|$" )) (make-local-variable 'paragraph-separate) (setq paragraph-separate paragraph-start) ... (make-local-variable 'comment-indent-function) (setq comment-indent-function 'lisp-comment-indent)) Each of the different Lisp modes has a slightly different keymap. For example, Lisp mode binds `C-c C-z' to `run-lisp', but the other Lisp modes do not. However, all Lisp modes have some commands in common. The following code sets up the common commands: (defvar shared-lisp-mode-map () "Keymap for commands shared by all sorts of Lisp modes.") (if shared-lisp-mode-map () (setq shared-lisp-mode-map (make-sparse-keymap)) (define-key shared-lisp-mode-map "\e\C-q" 'indent-sexp) (define-key shared-lisp-mode-map "\177" 'backward-delete-char-untabify)) And here is the code to set up the keymap for Lisp mode: (defvar lisp-mode-map () "Keymap for ordinary Lisp mode....") (if lisp-mode-map () (setq lisp-mode-map (make-sparse-keymap)) (set-keymap-parent lisp-mode-map shared-lisp-mode-map) (define-key lisp-mode-map "\e\C-x" 'lisp-eval-defun) (define-key lisp-mode-map "\C-c\C-z" 'run-lisp)) Finally, here is the complete major mode function definition for Emacs Lisp mode. (defun lisp-mode () "Major mode for editing Lisp code for Lisps other than GNU Emacs Lisp. Commands: Delete converts tabs to spaces as it moves back. Blank lines separate paragraphs. Semicolons start comments. \\{lisp-mode-map} Note that `run-lisp' may be used either to start an inferior Lisp job or to switch back to an existing one. Entry to this mode calls the value of `lisp-mode-hook' if that value is non-nil." (interactive) (kill-all-local-variables) (use-local-map lisp-mode-map) ; Select the mode's keymap. (setq major-mode 'lisp-mode) ; This is how `describe-mode' ; finds out what to describe. (setq mode-name "Lisp") ; This goes into the mode line. (lisp-mode-variables t) ; This defines various variables. (setq imenu-case-fold-search t) (set-syntax-table lisp-mode-syntax-table) (run-hooks 'lisp-mode-hook)) ; This permits the user to use a ; hook to customize the mode. How Emacs Chooses a Major Mode ------------------------------ 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. - Command: fundamental-mode Fundamental mode is a major mode that is not specialized for anything in particular. Other major modes are defined in effect by comparison with this one--their definitions say what to change, starting from Fundamental mode. The `fundamental-mode' function does *not* run any hooks; you're not supposed to customize it. (If you want Emacs to behave differently in Fundamental mode, change the *global* state of Emacs.) - Command: normal-mode &optional FIND-FILE This function establishes the proper major mode and buffer-local variable bindings for the current buffer. First it calls `set-auto-mode', then it runs `hack-local-variables' to parse, and bind or evaluate as appropriate, the file's local variables. If the FIND-FILE argument to `normal-mode' is non-`nil', `normal-mode' assumes that the `find-file' function is calling it. In this case, it may process a local variables list at the end of the file and in the `-*-' line. The variable `enable-local-variables' controls whether to do so. *Note Local Variables in Files: (emacs)File variables, for the syntax of the local variables section of a file. If you run `normal-mode' interactively, the argument FIND-FILE is normally `nil'. In this case, `normal-mode' unconditionally processes any local variables list. `normal-mode' uses `condition-case' around the call to the major mode function, so errors are caught and reported as a `File mode specification error', followed by the original error message. - User Option: enable-local-variables This variable controls processing of local variables lists in files being visited. A value of `t' means process the local variables lists unconditionally; `nil' means ignore them; anything else means ask the user what to do for each file. The default value is `t'. - Variable: ignored-local-variables This variable holds a list of variables that should not be set by a file's local variables list. Any value specified for one of these variables is ignored. In addition to this list, any variable whose name has a non-`nil' `risky-local-variable' property is also ignored. - User Option: enable-local-eval This variable controls processing of `Eval:' in local variables lists in files being visited. A value of `t' means process them unconditionally; `nil' means ignore them; anything else means ask the user what to do for each file. The default value is `maybe'. - Function: set-auto-mode This function selects the major mode that is appropriate for the current buffer. It may base its decision on the value of the `-*-' line, on the visited file name (using `auto-mode-alist'), on the `#!' line (using `interpreter-mode-alist'), or on the file's local variables list. However, this function does not look for the `mode:' local variable near the end of a file; the `hack-local-variables' function does that. *Note How Major Modes are Chosen: (emacs)Choosing Modes. - User Option: default-major-mode This variable holds the default major mode for new buffers. The standard value is `fundamental-mode'. If the value of `default-major-mode' is `nil', Emacs uses the (previously) current buffer's major mode for the major mode of a new buffer. However, if that major mode symbol has a `mode-class' property with value `special', then it is not used for new buffers; Fundamental mode is used instead. The modes that have this property are those such as Dired and Rmail that are useful only with text that has been specially prepared. - Function: set-buffer-major-mode BUFFER This function sets the major mode of BUFFER to the value of `default-major-mode'. If that variable is `nil', it uses the current buffer's major mode (if that is suitable). The low-level primitives for creating buffers do not use this function, but medium-level commands such as `switch-to-buffer' and `find-file-noselect' use it whenever they create buffers. - Variable: initial-major-mode The value of this variable determines the major mode of the initial `*scratch*' buffer. The value should be a symbol that is a major mode command. The default value is `lisp-interaction-mode'. - Variable: auto-mode-alist This variable contains an association list of file name patterns (regular expressions; *note Regular Expressions::.) and corresponding major mode commands. Usually, the file name patterns test for suffixes, such as `.el' and `.c', but this need not be the case. An ordinary element of the alist looks like `(REGEXP . MODE-FUNCTION)'. For example, (("\\`/tmp/fol/" . text-mode) ("\\.texinfo\\'" . texinfo-mode) ("\\.texi\\'" . texinfo-mode) ("\\.el\\'" . emacs-lisp-mode) ("\\.c\\'" . c-mode) ("\\.h\\'" . c-mode) ...) When you visit a file whose expanded file name (*note File Name Expansion::.) matches a REGEXP, `set-auto-mode' calls the corresponding MODE-FUNCTION. This feature enables Emacs to select the proper major mode for most files. If an element of `auto-mode-alist' has the form `(REGEXP FUNCTION t)', then after calling FUNCTION, Emacs searches `auto-mode-alist' again for a match against the portion of the file name that did not match before. This feature is useful for uncompression packages: an entry of the form `("\\.gz\\'" FUNCTION t)' can uncompress the file and then put the uncompressed file in the proper mode according to the name sans `.gz'. Here is an example of how to prepend several pattern pairs to `auto-mode-alist'. (You might use this sort of expression in your `.emacs' file.) (setq auto-mode-alist (append ;; File name (within directory) starts with a dot. '(("/\\.[^/]*\\'" . fundamental-mode) ;; File name has no dot. ("[^\\./]*\\'" . fundamental-mode) ;; File name ends in `.C'. ("\\.C\\'" . c++-mode)) auto-mode-alist)) - Variable: interpreter-mode-alist This variable specifies major modes to use for scripts that specify a command interpreter in an `#!' line. Its value is a list of elements of the form `(INTERPRETER . MODE)'; for example, `("perl" . perl-mode)' is one element present by default. The element says to use mode MODE if the file specifies an interpreter which matches INTERPRETER. The value of INTERPRETER is actually a regular expression. This variable is applicable only when the `auto-mode-alist' does not indicate which major mode to use. - Function: hack-local-variables &optional FORCE This function parses, and binds or evaluates as appropriate, any local variables specified by the contents of the current buffer. The handling of `enable-local-variables' documented for `normal-mode' actually takes place here. The argument FORCE usually comes from the argument FIND-FILE given to `normal-mode'. Getting Help about a Major Mode ------------------------------- The `describe-mode' function is used to provide information about major modes. It is normally called with `C-h m'. The `describe-mode' function uses the value of `major-mode', which is why every major mode function needs to set the `major-mode' variable. - Command: describe-mode This function displays the documentation of the current major mode. The `describe-mode' function calls the `documentation' function using the value of `major-mode' as an argument. Thus, it displays the documentation string of the major mode function. (*Note Accessing Documentation::.) - Variable: major-mode This variable holds the symbol for the current buffer's major mode. This symbol should have a function definition that is the command to switch to that major mode. The `describe-mode' function uses the documentation string of the function as the documentation of the major mode. Defining Derived Modes ---------------------- It's often useful to define a new major mode in terms of an existing one. An easy way to do this is to use `define-derived-mode'. - Macro: define-derived-mode VARIANT PARENT NAME DOCSTRING BODY... This construct defines VARIANT as a major mode command, using NAME as the string form of the mode name. The new command VARIANT is defined to call the function PARENT, then override certain aspects of that parent mode: * The new mode has its own keymap, named `VARIANT-map'. `define-derived-mode' initializes this map to inherit from `PARENT-map', if it is not already set. * The new mode has its own syntax table, kept in the variable `VARIANT-syntax-table'. `define-derived-mode' initializes this variable by copying `PARENT-syntax-table', if it is not already set. * The new mode has its own abbrev table, kept in the variable `VARIANT-abbrev-table'. `define-derived-mode' initializes this variable by copying `PARENT-abbrev-table', if it is not already set. * The new mode has its own mode hook, `VARIANT-hook', which it runs in standard fashion as the very last thing that it does. (The new mode also runs the mode hook of PARENT as part of calling PARENT.) In addition, you can specify how to override other aspects of PARENT with BODY. The command VARIANT evaluates the forms in BODY after setting up all its usual overrides, just before running `VARIANT-hook'. The argument DOCSTRING specifies the documentation string for the new mode. If you omit DOCSTRING, `define-derived-mode' generates a documentation string. Here is a hypothetical example: (define-derived-mode hypertext-mode text-mode "Hypertext" "Major mode for hypertext. \\{hypertext-mode-map}" (setq case-fold-search nil)) (define-key hypertext-mode-map [down-mouse-3] 'do-hyper-link) Minor Modes =========== A "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 a modification of single major mode. 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. 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, and the use of keymaps and other tables. In addition, there are several conventions that are specific to minor modes. * Make a variable whose name ends in `-mode' to control the minor mode. We call this the "mode variable". The minor mode command should set this variable (`nil' to disable; anything else to enable). If it is 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. This variable is used in conjunction with the `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. * 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 `nil', it should toggle the mode (turn it on if it is off, and off if it is on). Otherwise, it should turn the mode on if the argument is a positive integer, a symbol other than `nil' or `-', or a list whose CAR is such an integer or symbol; it should turn the mode off otherwise. Here is an example taken from the definition of `transient-mark-mode'. It shows the use of `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. (setq transient-mark-mode (if (null arg) (not transient-mark-mode) (> (prefix-numeric-value arg) 0))) * Add an element to `minor-mode-alist' for each minor mode (*note Mode Line Variables::.), if you want to indicate the minor mode in the mode line. This element should be a list of the following form: (MODE-VARIABLE STRING) Here MODE-VARIABLE is the variable that controls enabling of the minor mode, and STRING is a short string, starting with a space, to represent the mode in the mode line. These strings must be short so that there is room for several of them at once. When you add an element to `minor-mode-alist', use `assq' to check for an existing element, to avoid duplication. For example: (or (assq 'leif-mode minor-mode-alist) (setq minor-mode-alist (cons '(leif-mode " Leif") minor-mode-alist))) You can also use `add-to-list' to add an element to this list just once (*note Setting Variables::.). Keymaps and Minor Modes ----------------------- Each minor mode can have its own keymap, which is active when the mode is enabled. To set up a keymap for a minor mode, add an element to the alist `minor-mode-map-alist'. *Note Active Keymaps::. One use of minor mode keymaps is to modify the behavior of certain self-inserting characters so that they do something else as well as self-insert. In general, this is the only way to do that, since the facilities for customizing `self-insert-command' are limited to special cases (designed for abbrevs and Auto Fill mode). (Do not try substituting your own definition of `self-insert-command' for the standard one. The editor command loop handles this function specially.) The key sequences bound in a minor mode should consist of `C-c' followed by a punctuation character *other than* `{', `}', `<', `>', `:' or `;'. (Those few punctuation characters are reserved for major modes.) Easy-Mmode ---------- The easy-mmode package provides a convenient way of implementing a minor mode; with it, you can specify all about a simple minor mode in one self-contained definition. - Macro: easy-mmode-define-minor-mode MODE DOC &optional INIT-VALUE MODE-INDICATOR KEYMAP This macro defines a new minor mode whose name is MODE (a symbol). This macro defines a command named MODE which toggles the minor mode, and has DOC as its documentation string. It also defines a variable named MODE, which is set to `t' or `nil' by enabling or disabling the mode. The variable is initialized to INIT-VALUE. The string MODE-INDICATOR says what to display in the mode line when the mode is enabled; if it is `nil', the mode is not displayed in the mode line. The optional argument KEYMAP specifies the keymap for the minor mode. It can be a variable name, whose value is the keymap, or it can be an alist specifying bindings in this form: (KEY-SEQUENCE . DEFINITION) Here is an example of using `easy-mmode-define-minor-mode': (easy-mmode-define-minor-mode hungry-mode "Toggle Hungry mode. With no argument, this command toggles the mode. Non-null prefix argument turns on the mode. Null prefix argument turns off the mode. When Hungry mode is enabled, the control delete key gobbles all preceding whitespace except the last. See the command \\[hungry-electric-delete]." ;; The initial value. nil ;; The indicator for the mode line. " Hungry" ;; The minor mode bindings. '(("\C-\^?" . hungry-electric-delete) ("\C-\M-\^?" . (lambda () (interactive) (hungry-electric-delete t))))) This defines a minor mode named "Hungry mode", a command named `hungry-mode' to toggle it, a variable named `hungry-mode' which indicates whether the mode is enabled, and a variable named `hungry-mode-map' which holds the keymap that is active when the mode is enabled. It initializes the keymap with key bindings for `C-' and `C-M-'. Mode Line Format ================ Each Emacs window (aside from minibuffer windows) includes a mode line, which displays status information about the buffer displayed in the window. The mode line contains information about the buffer, such as its name, associated file, depth of recursive editing, and the major and minor modes. This section describes how the contents of the mode line are controlled. We include it in this chapter because much of the information displayed in the mode line relates to the enabled major and minor modes. `mode-line-format' is a buffer-local variable that holds a template used to display the mode line of the current buffer. All windows for the same buffer use the same `mode-line-format' and their mode lines appear the same (except for scrolling percentages, and line and column numbers). The mode line of a window is normally updated whenever a different buffer is shown in the window, or when the buffer's modified-status changes from `nil' to `t' or vice-versa. If you modify any of the variables referenced by `mode-line-format' (*note Mode Line Variables::.), or any other variables and data structures that affect how text is displayed (*note 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. - Function: force-mode-line-update Force redisplay of the current buffer's mode line. The mode line is usually displayed in inverse video; see `mode-line-inverse-video' in *Note Inverse Video::. The Data Structure of the Mode Line ----------------------------------- The mode line contents are controlled by a data structure of lists, strings, symbols, and numbers kept in the buffer-local variable `mode-line-format'. The data structure is called a "mode line construct", and it is built in recursive fashion out of simpler mode line constructs. The same data structure is used for constructing frame titles (*note Frame Titles::.). - Variable: mode-line-format The value of this variable is a mode line construct with overall responsibility for the mode line format. The value of this variable controls which other variables are used to form the mode line text, and where they appear. A mode line construct may be as simple as a fixed string of text, but it usually specifies how to use other variables to construct the text. Many of these variables are themselves defined to have mode line constructs as their values. The default value of `mode-line-format' incorporates the values of variables such as `mode-name' and `minor-mode-alist'. Because of this, very few modes need to alter `mode-line-format' itself. For most purposes, it is sufficient to alter some of the variables that `mode-line-format' refers to. A mode line construct may be a list, a symbol, or a string. If the value is a list, each element may be a list, a symbol, or a string. `STRING' A string as a mode line construct is displayed verbatim in the mode line except for "`%'-constructs". Decimal digits after the `%' specify the field width for space filling on the right (i.e., the data is left justified). *Note %-Constructs::. `SYMBOL' A symbol as a mode line construct stands for its value. The value of SYMBOL is used as a mode line construct, in place of SYMBOL. However, the symbols `t' and `nil' are ignored; so is any symbol whose value is void. There is one exception: if the value of SYMBOL is a string, it is displayed verbatim: the `%'-constructs are not recognized. `(STRING REST...) or (LIST REST...)' 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. `(SYMBOL THEN ELSE)' A list whose first element is a symbol is a conditional. Its meaning depends on the value of SYMBOL. If the value is non-`nil', the second element, THEN, is processed recursively as a mode line element. But if the value of SYMBOL is `nil', the third element, ELSE, is processed recursively. You may omit ELSE; then the mode line element displays nothing if the value of SYMBOL is `nil'. `(WIDTH REST...)' A list whose first element is an integer specifies truncation or padding of the results of REST. The remaining elements REST are processed recursively as mode line constructs and concatenated together. Then the result is space filled (if WIDTH is positive) or truncated (to -WIDTH columns, if WIDTH is negative) on the right. For example, the usual way to show what percentage of a buffer is above the top of the window is to use a list like this: `(-3 "%p")'. If you do alter `mode-line-format' itself, the new value should use the same variables that appear in the default value (*note Mode Line Variables::.), rather than duplicating their contents or displaying the information in another fashion. This way, customizations made by the user or by Lisp programs (such as `display-time' and major modes) via changes to those variables remain effective. Here is an example of a `mode-line-format' that might be useful for `shell-mode', since it contains the host name and default directory. (setq mode-line-format (list "-" 'mode-line-mule-info 'mode-line-modified 'mode-line-frame-identification "%b--" ;; Note that this is evaluated while making the list. ;; It makes a mode line construct which is just a string. (getenv "HOST") ":" 'default-directory " " 'global-mode-string " %[(" 'mode-name 'mode-line-process 'minor-mode-alist "%n" ")%]--" '(which-func-mode ("" which-func-format "--")) '(line-number-mode "L%l--") '(column-number-mode "C%c--") '(-3 . "%p") "-%-")) (The variables `line-number-mode', `column-number-mode' and `which-func-mode' enable particular minor modes; as usual, these variable names are also the minor mode command names.) Variables Used in the Mode Line ------------------------------- This section describes variables incorporated by the standard value of `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 `mode-line-format' were changed to use them. - Variable: mode-line-mule-info This variable holds the value of the mode-line construct that displays information about the language environment, buffer coding system, and current input method. *Note Non-ASCII Characters::. - Variable: mode-line-modified This variable holds the value of the mode-line construct that displays whether the current buffer is modified. The default value of `mode-line-modified' is `("%1*%1+")'. This means that the mode line displays `**' if the buffer is modified, `--' if the buffer is not modified, `%%' if the buffer is read only, and `%*' if the buffer is read only and modified. Changing this variable does not force an update of the mode line. - Variable: mode-line-frame-identification This variable identifies the current frame. The default value is `" "' if you are using a window system which can show multiple frames, or `"-%F "' on an ordinary terminal which shows only one frame at a time. - Variable: mode-line-buffer-identification This variable identifies the buffer being displayed in the window. Its default value is `("%12b")', which displays the buffer name, padded with spaces to at least 12 columns. - Variable: global-mode-string This variable holds a mode line spec that appears in the mode line by default, just after the buffer name. The command `display-time' sets `global-mode-string' to refer to the variable `display-time-string', which holds a string containing the time and load information. The `%M' construct substitutes the value of `global-mode-string', but that is obsolete, since the variable is included in the mode line from `mode-line-format'. - Variable: mode-name This buffer-local variable holds the "pretty" name of the current buffer's major mode. Each major mode should set this variable so that the mode name will appear in the mode line. - Variable: minor-mode-alist This variable holds an association list whose elements specify how the mode line should indicate that a minor mode is active. Each element of the `minor-mode-alist' should be a two-element list: (MINOR-MODE-VARIABLE MODE-LINE-STRING) More generally, MODE-LINE-STRING can be any mode line spec. It appears in the mode line when the value of MINOR-MODE-VARIABLE is non-`nil', and not otherwise. These strings should begin with spaces so that they don't run together. Conventionally, the MINOR-MODE-VARIABLE for a specific mode is set to a non-`nil' value when that minor mode is activated. The default value of `minor-mode-alist' is: minor-mode-alist => ((vc-mode vc-mode) (abbrev-mode " Abbrev") (overwrite-mode overwrite-mode) (auto-fill-function " Fill") (defining-kbd-macro " Def") (isearch-mode isearch-mode)) `minor-mode-alist' itself is not buffer-local. Each variable mentioned in the alist should be buffer-local if its minor mode can be enabled separately in each buffer. - Variable: mode-line-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 `*shell*' buffer is `(":%s")', which allows the shell to display its status along with the major mode as: `(Shell: run)'. Normally this variable is `nil'. - Variable: default-mode-line-format This variable holds the default `mode-line-format' for buffers that do not override it. This is the same as `(default-value 'mode-line-format)'. The default value of `default-mode-line-format' is this list: ("-" mode-line-mule-info mode-line-modified mode-line-frame-identification mode-line-buffer-identification " " global-mode-string " %[(" mode-name mode-line-process minor-mode-alist "%n" ")%]--" (which-func-mode ("" which-func-format "--")) (line-number-mode "L%l--") (column-number-mode "C%c--") (-3 . "%p") "-%-") - Variable: vc-mode The variable `vc-mode', buffer-local in each buffer, records whether the buffer's visited file is maintained with version control, and, if so, which kind. Its value is `nil' for no version control, or a string that appears in the mode line. `%'-Constructs in the Mode Line ------------------------------- The following table lists the recognized `%'-constructs and what they mean. In any construct except `%%', you can add a decimal integer after the `%' to specify how many characters to display. `%b' The current buffer name, obtained with the `buffer-name' function. *Note Buffer Names::. `%f' The visited file name, obtained with the `buffer-file-name' function. *Note Buffer File Name::. `%F' The title (only on a window system) or the name of the selected frame. *Note Window Frame Parameters::. `%c' The current column number of point. `%l' The current line number of point. `%*' `%' if the buffer is read only (see `buffer-read-only'); `*' if the buffer is modified (see `buffer-modified-p'); `-' otherwise. *Note Buffer Modification::. `%+' `*' if the buffer is modified (see `buffer-modified-p'); `%' if the buffer is read only (see `buffer-read-only'); `-' otherwise. This differs from `%*' only for a modified read-only buffer. *Note Buffer Modification::. `%&' `*' if the buffer is modified, and `-' otherwise. `%s' The status of the subprocess belonging to the current buffer, obtained with `process-status'. *Note Process Information::. `%t' Whether the visited file is a text file or a binary file. (This is a meaningful distinction only on certain operating systems.) `%p' The percentage of the buffer text above the *top* of window, or `Top', `Bottom' or `All'. `%P' The percentage of the buffer text that is above the *bottom* of the window (which includes the text visible in the window, as well as the text above the top), plus `Top' if the top of the buffer is visible on screen; or `Bottom' or `All'. `%n' `Narrow' when narrowing is in effect; nothing otherwise (see `narrow-to-region' in *Note Narrowing::). `%[' An indication of the depth of recursive editing levels (not counting minibuffer levels): one `[' for each editing level. *Note Recursive Editing::. `%]' One `]' for each recursive editing level (not counting minibuffer levels). `%%' The character `%'--this is how to include a literal `%' in a string in which `%'-constructs are allowed. `%-' Dashes sufficient to fill the remainder of the mode line. The following two `%'-constructs are still supported, but they are obsolete, since you can get the same results with the variables `mode-name' and `global-mode-string'. `%m' The value of `mode-name'. `%M' The value of `global-mode-string'. Currently, only `display-time' modifies the value of `global-mode-string'. Imenu ===== "Imenu" is a feature that lets users select a definition or section in the buffer, from a menu which lists all of them, to go directly to that location in the buffer. Imenu works by constructing a buffer index which lists the names and positions of the definitions or portions of in the buffer, so the user can pick one of them to move to. This section explains how to customize Imenu for a major mode. The usual and simplest way is to set the variable `imenu-generic-expression': - Variable: imenu-generic-expression This variable, if non-`nil', specifies regular expressions for finding definitions for Imenu. In the simplest case, elements should look like this: (MENU-TITLE REGEXP SUBEXP) Here, if MENU-TITLE is non-`nil', it says that the matches for this element should go in a submenu of the buffer index; MENU-TITLE itself specifies the name for the submenu. If MENU-TITLE is `nil', the matches for this element go directly in the top level of the buffer index. The second item in the list, REGEXP, is a regular expression (*note Regular Expressions::.); wherever it matches, that is a definition to mention in the buffer index. The third item, SUBEXP, indicates which subexpression in REGEXP matches the definition's name. An element can also look like this: (MENU-TITLE REGEXP INDEX FUNCTION ARGUMENTS...) Each match for this element creates a special index item which, if selected by the user, calls FUNCTION with arguments ITEM-NAME, the buffer position, and ARGUMENTS. For Emacs Lisp mode, PATTERN could look like this: ((nil "^\\s-*(def\\(un\\|subst\\|macro\\|advice\\)\ \\s-+\\([-A-Za-z0-9+]+\\)" 2) ("*Vars*" "^\\s-*(def\\(var\\|const\\)\ \\s-+\\([-A-Za-z0-9+]+\\)" 2) ("*Types*" "^\\s-*\ (def\\(type\\|struct\\|class\\|ine-condition\\)\ \\s-+\\([-A-Za-z0-9+]+\\)" 2)) Setting this variable makes it buffer-local in the current buffer. - Variable: imenu-case-fold-search This variable controls whether matching against IMENU-GENERIC-EXPRESSION is case-sensitive: `t', the default, means matching should ignore case. Setting this variable makes it buffer-local in the current buffer. - Variable: imenu-syntax-alist This variable is an alist of syntax table modifiers to use while processing `imenu-generic-expression', to override the syntax table of the current buffer. Each element should have this form: (CHARACTERS . SYNTAX-DESCRIPTION) The CAR, CHARACTERS, can be either a character or a string. The element says to give that character or characters the syntax specified by SYNTAX-DESCRIPTION, which is passed to `modify-syntax-entry' (*note Syntax Table Functions::.). This feature is typically used to give word syntax to characters which normally have symbol syntax, and thus to simplify `imenu-generic-expression' and speed up matching. For example, Fortran mode uses it this way: (setq imenu-syntax-alist '(("_$" . "w"))) The `imenu-generic-expression' patterns can then use `\\sw+' instead of `\\(\\sw\\|\\s_\\)+'. Note that this technique may be inconvenient to use when the mode needs to limit the initial character of a name to a smaller set of characters than are allowed in the rest of a name. Setting this variable makes it buffer-local in the current buffer. Another way to customize Imenu for a major mode is to set the variables `imenu-prev-index-position-function' and `imenu-extract-index-name-function': - Variable: imenu-prev-index-position-function If this variable is non-`nil', its value should be a function for finding the next definition to mention in the buffer index, moving backwards in the file. The function should leave point at the place to be connected to the index item; it should return `nil' if it doesn't find another item. Setting this variable makes it buffer-local in the current buffer. - Variable: imenu-extract-index-name-function If this variable is non-`nil', its value should be a function to return the name for a definition, assuming point is in that definition as the `imenu-prev-index-position-function' function would leave it. Setting this variable makes it buffer-local in the current buffer. The last way to customize Imenu for a major mode is to set the variables `imenu-create-index-function': - Variable: imenu-create-index-function This variable specifies the function to use for creating a buffer index. The function should take no arguments, and return an index for the current buffer. It is called within `save-excursion', so where it leaves point makes no difference. The default value is a function that uses `imenu-generic-expression' to produce the index alist. If you specify a different function, then `imenu-generic-expression' is not used. Setting this variable makes it buffer-local in the current buffer. - Variable: imenu-index-alist This variable holds the index alist for the current buffer. Setting it makes it buffer-local in the current buffer. Simple elements in the alist look like `(INDEX-NAME . INDEX-POSITION)'. Selecting a simple element has the effect of moving to position INDEX-POSITION in the buffer. Special elements look like `(INDEX-NAME POSITION FUNCTION ARGUMENTS...)'. Selecting a special element performs (funcall FUNCTION INDEX-NAME POSITION ARGUMENTS...) A nested sub-alist element looks like `(INDEX-NAME SUB-ALIST)'. Font Lock Mode ============== "Font Lock mode" is a feature that automatically attaches `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 language--in other words, 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 (usually for regular expressions). Syntactic fontification happens first; it finds comments and string constants, and highlights them using `font-lock-comment-face' and `font-lock-string-face' (*note Faces for Font Lock::.); search-based fontification follows. Font Lock Basics ---------------- There are several variables that control how Font Lock mode highlights text. But major modes should not set any of these variables directly. Instead, it should set `font-lock-defaults' as a buffer-local variable. The value assigned to this variable is used, if and when Font Lock mode is enabled, to set all the other variables. - Variable: font-lock-defaults This variable is set by major modes, as a buffer-local variable, to specify how to fontify text in that mode. The value should look like this: (KEYWORDS KEYWORDS-ONLY CASE-FOLD SYNTAX-ALIST SYNTAX-BEGIN OTHER-VARS...) The first element, KEYWORDS, indirectly specifies the value of `font-lock-keywords'. It can be a symbol, a variable whose value is list to use for `font-lock-keywords'. It can also be a list of several such symbols, one for each possible level of fontification. The first symbol specifies how to do level 1 fontification, the second symbol how to do level 2, and so on. The second element, KEYWORDS-ONLY, specifies the value of the variable `font-lock-keywords-only'. If this is non-`nil', syntactic fontification (of strings and comments) is not performed. The third element, CASE-FOLD, specifies the value of `font-lock-case-fold-search'. If it is non-`nil', Font Lock mode ignores case when searching as directed by `font-lock-keywords'. If the fourth element, SYNTAX-ALIST, is non-`nil', it should be a list of cons cells of the form `(CHAR-OR-STRING . STRING)'. These are used to set up a syntax table for fontification (*note Syntax Table Functions::.). The resulting syntax table is stored in `font-lock-syntax-table'. The fifth element, SYNTAX-BEGIN, specifies the value of `font-lock-beginning-of-syntax-function' (see below). Any further elements OTHER-VARS are have form `(VARIABLE . VALUE)'. This kind of element means to make VARIABLE buffer-local and then set it to VALUE. This is used to set other variables that affect fontification. Search-based Fontification -------------------------- The most important variable for customizing Font Lock mode is `font-lock-keywords'. It specifies the search criteria for search-based fontification. - Variable: 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! Each element of `font-lock-keywords' specifies how to find certain cases of text, and how to highlight those cases. Font Lock mode processes the elements of `font-lock-keywords' one by one, and for each element, it finds and handles all matches. Ordinarily, once part of the text has been fontified already, this cannot be overridden by a subsequent match in the same text; but you can specify different behavior using the OVERRIDE element of a HIGHLIGHTER. Each element of `font-lock-keywords' should have one of these forms: `REGEXP' Highlight all matches for REGEXP using `font-lock-keyword-face'. For example, ;; Highlight discrete occurrences of `foo' ;; using `font-lock-keyword-face'. "\\" The function `regexp-opt' (*note Syntax of Regexps::.) is useful for calculating optimal regular expressions to match a number of different keywords. `FUNCTION' Find text by calling FUNCTION, and highlight the matches it finds using `font-lock-keyword-face'. When FUNCTION is called, it receives one argument, the limit of the search. It should return non-`nil' if it succeeds, and set the match data to describe the match that was found. `(MATCHER . MATCH)' In this kind of element, MATCHER stands for either a regular expression or a function, as described above. The CDR, MATCH, specifies which subexpression of MATCHER should be highlighted (instead of the entire text that MATCHER matched). ;; Highlight the `bar' in each occurrences of `fubar', ;; using `font-lock-keyword-face'. ("fu\\(bar\\)" . 1) If you use `regexp-opt' to produce the regular expression MATCHER, then you can use `regexp-opt-depth' (*note Syntax of Regexps::.) to calculate the value for MATCH. `(MATCHER . FACENAME)' In this kind of element, FACENAME is an expression whose value specifies the face name to use for highlighting. ;; Highlight occurrences of `fubar', ;; using the face which is the value of `fubar-face'. ("fubar" . fubar-face) `(MATCHER . HIGHLIGHTER)' In this kind of element, HIGHLIGHTER is a list which specifies how to highlight matches found by MATCHER. It has the form (SUBEXP FACENAME OVERRIDE LAXMATCH) The CAR, SUBEXP, is an integer specifying which subexpression of the match to fontify (0 means the entire matching text). The second subelement, FACENAME, specifies the face, as described above. The last two values in HIGHLIGHTER, OVERRIDE and LAXMATCH, are flags. If OVERRIDE is `t', this element can override existing fontification made by previous elements of `font-lock-keywords'. If it is `keep', then each character is fontified if it has not been fontified already by some other element. If it is `prepend', the face FACENAME is added to the beginning of the `face' property. If it is `append', the face FACENAME is added to the end of the `face' property. If LAXMATCH is non-`nil', it means there should be no error if there is no subexpression numbered SUBEXP in MATCHER. Here are some examples of elements of this kind, and what they do: ;; Highlight occurrences of either `foo' or `bar', ;; using `foo-bar-face', even if they have already been highlighted. ;; `foo-bar-face' should be a variable whose value is a face. ("foo\\|bar" 0 foo-bar-face t) ;; Highlight the first subexpression within each occurrences ;; that the function `fubar-match' finds, ;; using the face which is the value of `fubar-face'. (fubar-match 1 fubar-face) `(MATCHER HIGHLIGHTERS...)' This sort of element specifies several HIGHLIGHTER lists for a single MATCHER. In order for this to be useful, each HIGHLIGHTER should have a different value of SUBEXP; that is, each one should apply to a different subexpression of MATCHER. `(eval . FORM)' Here FORM is an expression to be evaluated the first time this value of `font-lock-keywords' is used in a buffer. Its value should have one of the forms described in this table. *Warning:* Do not design an element of `font-lock-keywords' to match text which spans lines; this does not work reliably. While `font-lock-fontify-buffer' handles multi-line patterns correctly, updating when you edit the buffer does not, since it considers text one line at a time. Other Font Lock Variables ------------------------- This section describes additional variables that a major mode can set by means of `font-lock-defaults'. - Variable: font-lock-keywords-only Non-`nil' means Font Lock should not fontify comments or strings syntactically; it should only fontify based on `font-lock-keywords'. - Variable: font-lock-keywords-case-fold-search Non-`nil' means that regular expression matching for the sake of `font-lock-keywords' should be case-insensitive. - Variable: font-lock-syntax-table This variable specifies the syntax table to use for fontification of comments and strings. - Variable: font-lock-beginning-of-syntax-function If this variable is non-`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 `beginning-of-line' (i.e., the start of the line is known to be outside a syntactic block), or `beginning-of-defun' for programming modes or `backward-paragraph' for textual modes (i.e., the mode-dependent function is known to move outside a syntactic block). If the value is `nil', the beginning of the buffer is used as a position outside of a syntactic block. This cannot be wrong, but it can be slow. - Variable: font-lock-mark-block-function If this variable is non-`nil', it should be a function that is called with no arguments, to choose an enclosing range of text for refontification for the command `M-g M-g' (`font-lock-fontify-block'). The function should report its choice by placing the region around it. A good choice is a range of text large enough to give proper results, but not too large so that refontification becomes slow. Typical values are `mark-defun' for programming modes or `mark-paragraph' for textual modes. Levels of Font Lock ------------------- Many major modes offer three different levels of fontification. You can define multiple levels by using a list of symbols for KEYWORDS in `font-lock-defaults'. Each symbol specifies one level of fontification; it is up to the user to choose one of these levels. The chosen level's symbol value is used to initialize `font-lock-keywords'. Here are the conventions for how to define the levels of fontification: * Level 1: highlight function declarations, file directives (such as include or import directives), strings and comments. The idea is speed, so only the most important and top-level components are fontified. * Level 2: in addition to level 1, highlight all language keywords, including type names that act like keywords, as well as named constant values. The idea is that all keywords (either syntactic or semantic) should be fontified appropriately. * Level 3: in addition to level 2, highlight the symbols being defined in function and variable declarations, and all builtin function names, wherever they appear. Faces for Font Lock ------------------- You can make Font Lock mode use any face, but several faces are defined specifically for Font Lock mode. Each of these symbols is both a face name, and a variable whose default value is the symbol itself. Thus, the default value of `font-lock-comment-face' is `font-lock-comment-face'. This means you can write `font-lock-comment-face' in a context such as `font-lock-keywords' where a face-name-valued expression is used. `font-lock-comment-face' Used (typically) for comments. `font-lock-string-face' Used (typically) for string constants. `font-lock-keyword-face' Used (typically) for keywords--names that have special syntactic significance, like `for' and `if' in C. `font-lock-builtin-face' Used (typically) for built-in function names. `font-lock-function-name-face' Used (typically) for the name of a function being defined or declared, in a function definition or declaration. `font-lock-variable-name-face' Used (typically) for the name of a variable being defined or declared, in a variable definition or declaration. `font-lock-type-face' Used (typically) for names of user-defined data types, where they are defined and where they are used. `font-lock-constant-face' Used (typically) for constant names. `font-lock-warning-face' Used (typically) for constructs that are peculiar, or that greatly change the meaning of other text. For example, this is used for `;;;###autoload' cookies in Emacs Lisp, and for `#error' directives in C. Syntactic Font Lock ------------------- Font Lock mode can be used to update `syntax-table' properties automatically. This is useful in languages for which a single syntax table by itself is not sufficient. - Variable: font-lock-syntactic-keywords This variable enables and controls syntactic Font Lock. Its value should be a list of elements of this form: (MATCHER SUBEXP SYNTAX OVERRIDE LAXMATCH) The parts of this element have the same meanings as in the corresponding sort of element of `font-lock-keywords', (MATCHER SUBEXP FACENAME OVERRIDE LAXMATCH) However, instead of specifying the value FACENAME to use for the `face' property, it specifies the value SYNTAX to use for the `syntax-table' property. Here, SYNTAX can be a variable whose value is a syntax table, a syntax entry of the form `(SYNTAX-CODE . MATCHING-CHAR)', or an expression whose value is one of those two types. Hooks ===== A "hook" is a variable where you can store a function or functions to be called on a particular occasion by an existing program. Emacs provides hooks for the sake of customization. Most often, hooks are set up in the `.emacs' file, but Lisp programs can set them also. *Note Standard Hooks::, for a list of standard hook variables. Most of the hooks in Emacs are "normal hooks". These variables contain lists of functions to be called with no arguments. When the hook name ends in `-hook', that tells you it is normal. We try to make all hooks normal, as much as possible, so that you can use them in a uniform way. Every major mode function is supposed to run a normal hook called the "mode hook" as the last step 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. But hooks are used in other contexts too. For example, the hook `suspend-hook' runs just before Emacs suspends itself (*note Suspending Emacs::.). The recommended way to add a hook function to a normal hook is by calling `add-hook' (see below). The hook functions may be any of the valid kinds of functions that `funcall' accepts (*note What Is a Function::.). Most normal hook variables are initially void; `add-hook' knows how to deal with this. If the hook variable's name does not end with `-hook', that indicates it is probably an "abnormal hook"; you should look at its documentation to see how to use the hook properly. If the variable's name ends in `-functions' or `-hooks', then the value is a list of functions, but it is abnormal in that either these functions are called with arguments or their values are used in some way. You can use `add-hook' to add a function to the list, but you must take care in writing the function. (A few of these variables are actually normal hooks which were named before we established the convention of using `-hook' for them.) If the variable's name ends in `-function', then its value is just a single function, not a list of functions. Here's an example that uses a mode hook to turn on Auto Fill mode when in Lisp Interaction mode: (add-hook 'lisp-interaction-mode-hook 'turn-on-auto-fill) At the appropriate time, Emacs uses the `run-hooks' function to run particular hooks. This function calls the hook functions that have been added with `add-hook'. - Function: run-hooks &rest HOOKVAR This function takes one or more hook variable names as arguments, and runs each hook in turn. Each HOOKVAR argument should be a symbol that is a hook variable. These arguments are processed in the order specified. If a hook variable has a non-`nil' value, that value may be a function or a list of functions. If the value is a function (either a lambda expression or a symbol with a function definition), it is called. If it is a list, the elements are called, in order. The hook functions are called with no arguments. Nowadays, storing a single function in the hook variable is semi-obsolete; you should always use a list of functions. For example, here's how `emacs-lisp-mode' runs its mode hook: (run-hooks 'emacs-lisp-mode-hook) - Function: run-hook-with-args HOOK &rest ARGS This function is the way to run an abnormal hook which passes arguments to the hook functions. It calls each of the hook functions, passing each of them the arguments ARGS. - Function: run-hook-with-args-until-failure HOOK &rest ARGS This function is the way to run an abnormal hook which passes arguments to the hook functions, and stops as soon as any hook function fails. It calls each of the hook functions, passing each of them the arguments ARGS, until some hook function returns `nil'. Then it stops, and returns `nil' if some hook function did, and otherwise returns a non-`nil' value. - Function: run-hook-with-args-until-success HOOK &rest ARGS This function is the way to run an abnormal hook which passes arguments to the hook functions, and stops as soon as any hook function succeeds. It calls each of the hook functions, passing each of them the arguments ARGS, until some hook function returns non-`nil'. Then it stops, and returns whatever was returned by the last hook function that was called. - Function: add-hook HOOK FUNCTION &optional APPEND LOCAL This function is the handy way to add function FUNCTION to hook variable HOOK. The argument FUNCTION may be any valid Lisp function with the proper number of arguments. For example, (add-hook 'text-mode-hook 'my-text-hook-function) adds `my-text-hook-function' to the hook called `text-mode-hook'. You can use `add-hook' for abnormal hooks as well as for normal hooks. 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, FUNCTION goes at the front of the hook list, so it will be executed first (barring another `add-hook' call). If the optional argument APPEND is non-`nil', the new hook function goes at the end of the hook list and will be executed last. If LOCAL is non-`nil', that says to make the new hook function buffer-local in the current buffer. Before you can do this, you must make the hook itself buffer-local by calling `make-local-hook' (*not* `make-local-variable'). If the hook itself is not buffer-local, then the value of LOCAL makes no difference--the hook function is always global. - Function: remove-hook HOOK FUNCTION &optional LOCAL This function removes FUNCTION from the hook variable HOOK. If LOCAL is non-`nil', that says to remove FUNCTION from the buffer-local hook list instead of from the global hook list. If the hook variable itself is not buffer-local, then the value of LOCAL makes no difference. - Function: make-local-hook HOOK This function makes the hook variable `hook' buffer-local in the current buffer. When a hook variable is buffer-local, it can have buffer-local and global hook functions, and `run-hooks' runs all of them. This function works by making `t' an element of the buffer-local value. That serves as a flag to use the hook functions in the default value of the hook variable as well as those in the buffer-local value. Since `run-hooks' understands this flag, `make-local-hook' works with all normal hooks. It works for only some non-normal hooks--those whose callers have been updated to understand this meaning of `t'. Do not use `make-local-variable' directly for hook variables; it is not sufficient. Documentation ************* GNU Emacs Lisp has convenient on-line help facilities, most of which derive their information from the documentation strings associated with functions and variables. This chapter describes how to write good documentation strings for your Lisp programs, as well as how to write programs to access documentation. Note that the documentation strings for Emacs are not the same thing as the Emacs manual. Manuals have their own source files, written in the Texinfo language; documentation strings are specified in the definitions of the functions and variables they apply to. A collection of documentation strings is not sufficient as a manual because a good manual is not organized in that fashion; it is organized in terms of topics of discussion. Documentation Basics ==================== A documentation string is written using the Lisp syntax for strings, with double-quote characters surrounding the text of the string. This is because it really is a Lisp string object. The string serves as documentation when it is written in the proper place in the definition of a function or variable. In a function definition, the documentation string follows the argument list. In a variable definition, the documentation string follows the initial value of the variable. When you write a documentation string, make the first line a complete sentence (or two complete sentences) since some commands, such as `apropos', show only the first line of a multi-line documentation string. Also, you should not indent the second line of a documentation string, if it has one, because that looks odd when you use `C-h f' (`describe-function') or `C-h v' (`describe-variable') to view the documentation string. *Note Documentation Tips::. Documentation strings can contain several special substrings, which stand for key bindings to be looked up in the current keymaps when the documentation is displayed. This allows documentation strings to refer to the keys for related commands and be accurate even when a user rearranges the key bindings. (*Note Accessing Documentation::.) In Emacs Lisp, a documentation string is accessible through the function or variable that it describes: * The documentation for a function is stored in the function definition itself (*note Lambda Expressions::.). The function `documentation' knows how to extract it. * The documentation for a variable is stored in the variable's property list under the property name `variable-documentation'. The function `documentation-property' knows how to retrieve it. To save space, the documentation for preloaded functions and variables (including primitive functions and autoloaded functions) is stored in the file `emacs/etc/DOC-VERSION'--not inside Emacs. The documentation strings for functions and variables loaded during the Emacs session from byte-compiled files are stored in those files (*note Docs and Compilation::.). The data structure inside Emacs has an integer offset into the file, or a list containing a file name and an integer, in place of the documentation string. The functions `documentation' and `documentation-property' use that information to fetch the documentation string from the appropriate file; this is transparent to the user. For information on the uses of documentation strings, see *Note Help: (emacs)Help. The `emacs/lib-src' directory contains two utilities that you can use to print nice-looking hardcopy for the file `emacs/etc/DOC-VERSION'. These are `sorted-doc' and `digest-doc'. Access to Documentation Strings =============================== - Function: documentation-property SYMBOL PROPERTY &optional VERBATIM This function returns the documentation string that is recorded in SYMBOL's property list under property PROPERTY. It retrieves the text from a file if necessary, and runs `substitute-command-keys' to substitute actual key bindings. (This substitution is not done if VERBATIM is non-`nil'.) (documentation-property 'command-line-processed 'variable-documentation) => "Non-nil once command line has been processed" (symbol-plist 'command-line-processed) => (variable-documentation 188902) - Function: documentation FUNCTION &optional VERBATIM This function returns the documentation string of FUNCTION. It reads the text from a file if necessary. Then (unless VERBATIM is non-`nil') it calls `substitute-command-keys', to return a value containing the actual (current) key bindings. The function `documentation' signals a `void-function' error if FUNCTION has no function definition. However, it is OK if the function definition has no documentation string. In that case, `documentation' returns `nil'. Here is an example of using the two functions, `documentation' and `documentation-property', to display the documentation strings for several symbols in a `*Help*' buffer. (defun describe-symbols (pattern) "Describe the Emacs Lisp symbols matching PATTERN. All symbols that have PATTERN in their name are described in the `*Help*' buffer." (interactive "sDescribe symbols matching: ") (let ((describe-func (function (lambda (s) ;; Print description of symbol. (if (fboundp s) ; It is a function. (princ (format "%s\t%s\n%s\n\n" s (if (commandp s) (let ((keys (where-is-internal s))) (if keys (concat "Keys: " (mapconcat 'key-description keys " ")) "Keys: none")) "Function") (or (documentation s) "not documented")))) (if (boundp s) ; It is a variable. (princ (format "%s\t%s\n%s\n\n" s (if (user-variable-p s) "Option " "Variable") (or (documentation-property s 'variable-documentation) "not documented"))))))) sym-list) ;; Build a list of symbols that match pattern. (mapatoms (function (lambda (sym) (if (string-match pattern (symbol-name sym)) (setq sym-list (cons sym sym-list)))))) ;; Display the data. (with-output-to-temp-buffer "*Help*" (mapcar describe-func (sort sym-list 'string<)) (print-help-return-message)))) The `describe-symbols' function works like `apropos', but provides more information. (describe-symbols "goal") ---------- Buffer: *Help* ---------- goal-column Option *Semipermanent goal column for vertical motion, as set by ... set-goal-column Keys: C-x C-n Set the current horizontal position as a goal for C-n and C-p. Those commands will move to this position in the line moved to rather than trying to keep the same horizontal position. With a non-nil argument, clears out the goal column so that C-n and C-p resume vertical motion. The goal column is stored in the variable `goal-column'. temporary-goal-column Variable Current goal column for vertical motion. It is the column where point was at the start of current run of vertical motion commands. When the `track-eol' feature is doing its job, the value is 9999. ---------- Buffer: *Help* ---------- - Function: Snarf-documentation FILENAME This function is used only during Emacs initialization, just before the runnable Emacs is dumped. It finds the file offsets of the documentation strings stored in the file FILENAME, and records them in the in-core function definitions and variable property lists in place of the actual strings. *Note Building Emacs::. Emacs reads the file FILENAME from the `emacs/etc' directory. When the dumped Emacs is later executed, the same file will be looked for in the directory `doc-directory'. Usually FILENAME is `"DOC-VERSION"'. - Variable: doc-directory This variable holds the name of the directory which should contain the file `"DOC-VERSION"' that contains documentation strings for built-in and preloaded functions and variables. In most cases, this is the same as `data-directory'. They may be different when you run Emacs from the directory where you built it, without actually installing it. See `data-directory' in *Note Help Functions::. In older Emacs versions, `exec-directory' was used for this. Substituting Key Bindings in Documentation ========================================== When documentation strings refer to key sequences, they should use the current, actual key bindings. They can do so using certain special text sequences described below. Accessing documentation strings in the usual way substitutes current key binding information for these special sequences. This works by calling `substitute-command-keys'. You can also call that function yourself. Here is a list of the special sequences and what they mean: `\[COMMAND]' stands for a key sequence that will invoke COMMAND, or `M-x COMMAND' if COMMAND has no key bindings. `\{MAPVAR}' stands for a summary of the keymap which is the value of the variable MAPVAR. The summary is made using `describe-bindings'. `\' stands for no text itself. It is used only for a side effect: it specifies MAPVAR's value as the keymap for any following `\[COMMAND]' sequences in this documentation string. `\=' quotes the following character and is discarded; thus, `\=\[' puts `\[' into the output, and `\=\=' puts `\=' into the output. *Please note:* Each `\' must be doubled when written in a string in Emacs Lisp. - Function: substitute-command-keys STRING This function scans STRING for the above special sequences and replaces them by what they stand for, returning the result as a string. This permits display of documentation that refers accurately to the user's own customized key bindings. Here are examples of the special sequences: (substitute-command-keys "To abort recursive edit, type: \\[abort-recursive-edit]") => "To abort recursive edit, type: C-]" (substitute-command-keys "The keys that are defined for the minibuffer here are: \\{minibuffer-local-must-match-map}") => "The keys that are defined for the minibuffer here are: ? minibuffer-completion-help SPC minibuffer-complete-word TAB minibuffer-complete C-j minibuffer-complete-and-exit RET minibuffer-complete-and-exit C-g abort-recursive-edit " (substitute-command-keys "To abort a recursive edit from the minibuffer, type\ \\\\[abort-recursive-edit].") => "To abort a recursive edit from the minibuffer, type C-g." Describing Characters for Help Messages ======================================= These functions convert events, key sequences, or characters to textual descriptions. These descriptions are useful for including arbitrary text characters or key sequences in messages, because they convert non-printing and whitespace characters to sequences of printing characters. The description of a non-whitespace printing character is the character itself. - Function: key-description SEQUENCE This function returns a string containing the Emacs standard notation for the input events in SEQUENCE. The argument SEQUENCE may be a string, vector or list. *Note Input Events::, for more information about valid events. See also the examples for `single-key-description', below. - Function: single-key-description EVENT This function returns a string describing EVENT in the standard Emacs notation for keyboard input. A normal printing character appears as itself, but a control character turns into a string starting with `C-', a meta character turns into a string starting with `M-', and space, tab, etc. appear as `SPC', `TAB', etc. A function key symbol appears as itself. An event that is a list appears as the name of the symbol in the CAR of the list. (single-key-description ?\C-x) => "C-x" (key-description "\C-x \M-y \n \t \r \f123") => "C-x SPC M-y SPC C-j SPC TAB SPC RET SPC C-l 1 2 3" (single-key-description 'C-mouse-1) => "C-mouse-1" - Function: text-char-description CHARACTER This function returns a string describing CHARACTER in the standard Emacs notation for characters that appear in text--like `single-key-description', except that control characters are represented with a leading caret (which is how control characters in Emacs buffers are usually displayed). (text-char-description ?\C-c) => "^C" (text-char-description ?\M-m) => "M-m" (text-char-description ?\C-\M-m) => "M-^M" - Function: read-kbd-macro STRING This function is used mainly for operating on keyboard macros, but it can also be used as a rough inverse for `key-description'. You call it with a string containing key descriptions, separated by spaces; it returns a string or vector containing the corresponding events. (This may or may not be a single valid key sequence, depending on what events you use; *note Keymap Terminology::..) Help Functions ============== Emacs provides a variety of on-line help functions, all accessible to the user as subcommands of the prefix `C-h'. For more information about them, see *Note Help: (emacs)Help. Here we describe some program-level interfaces to the same information. - Command: apropos REGEXP &optional DO-ALL This function finds all symbols whose names contain a match for the regular expression REGEXP, and returns a list of them (*note Regular Expressions::.). It also displays the symbols in a buffer named `*Help*', each with a one-line description taken from the beginning of its documentation string. If DO-ALL is non-`nil', then `apropos' also shows key bindings for the functions that are found; it also shows all symbols, even those that are neither functions nor variables. In the first of the following examples, `apropos' finds all the symbols with names containing `exec'. (We don't show here the output that results in the `*Help*' buffer.) (apropos "exec") => (Buffer-menu-execute command-execute exec-directory exec-path execute-extended-command execute-kbd-macro executing-kbd-macro executing-macro) - Variable: help-map The value of this variable is a local keymap for characters following the Help key, `C-h'. - Prefix Command: help-command This symbol is not a function; its function definition cell holds the keymap known as `help-map'. It is defined in `help.el' as follows: (define-key global-map "\C-h" 'help-command) (fset 'help-command help-map) - Function: print-help-return-message &optional FUNCTION This function builds a string that explains how to restore the previous state of the windows after a help command. After building the message, it applies FUNCTION to it if FUNCTION is non-`nil'. Otherwise it calls `message' to display it in the echo area. This function expects to be called inside a `with-output-to-temp-buffer' special form, and expects `standard-output' to have the value bound by that special form. For an example of its use, see the long example in *Note Accessing Documentation::. - Variable: help-char The value of this variable is the help character--the character that Emacs recognizes as meaning Help. By default, its value is 8, which stands for `C-h'. When Emacs reads this character, if `help-form' is a non-`nil' Lisp expression, it evaluates that expression, and displays the result in a window if it is a string. Usually the value of `help-form' is `nil'. Then the help character has no special meaning at the level of command input, and it becomes part of a key sequence in the normal way. The standard key binding of `C-h' is a prefix key for several general-purpose help features. The help character is special after prefix keys, too. If it has no binding as a subcommand of the prefix key, it runs `describe-prefix-bindings', which displays a list of all the subcommands of the prefix key. - Variable: help-event-list The value of this variable is a list of event types that serve as alternative "help characters." These events are handled just like the event specified by `help-char'. - Variable: help-form If this variable is non-`nil', its value is a form to evaluate whenever the character `help-char' is read. If evaluating the form produces a string, that string is displayed. A command that calls `read-event' or `read-char' probably should bind `help-form' to a non-`nil' expression while it does input. (The time when you should not do this is when `C-h' has some other meaning.) Evaluating this expression should result in a string that explains what the input is for and how to enter it properly. Entry to the minibuffer binds this variable to the value of `minibuffer-help-form' (*note Minibuffer Misc::.). - Variable: prefix-help-command This variable holds a function to print help for a prefix key. The function is called when the user types a prefix key followed by the help character, and the help character has no binding after that prefix. The variable's default value is `describe-prefix-bindings'. - Function: describe-prefix-bindings This function calls `describe-bindings' to display a list of all the subcommands of the prefix key of the most recent key sequence. The prefix described consists of all but the last event of that key sequence. (The last event is, presumably, the help character.) The following two functions are meant for modes that want to provide help without relinquishing control, such as the "electric" modes. Their names begin with `Helper' to distinguish them from the ordinary help functions. - Command: Helper-describe-bindings This command pops up a window displaying a help buffer containing a listing of all of the key bindings from both the local and global keymaps. It works by calling `describe-bindings'. - Command: Helper-help This command provides help for the current mode. It prompts the user in the minibuffer with the message `Help (Type ? for further options)', and then provides assistance in finding out what the key bindings are, and what the mode is intended for. It returns `nil'. This can be customized by changing the map `Helper-help-map'. - Variable: data-directory This variable holds the name of the directory in which Emacs finds certain documentation and text files that come with Emacs. In older Emacs versions, `exec-directory' was used for this. - Macro: make-help-screen FNAME HELP-LINE HELP-TEXT HELP-MAP This macro defines a help command named FNAME that acts like a prefix key that shows a list of the subcommands it offers. When invoked, FNAME displays HELP-TEXT in a window, then reads and executes a key sequence according to HELP-MAP. The string HELP-TEXT should describe the bindings available in HELP-MAP. The command FNAME is defined to handle a few events itself, by scrolling the display of HELP-TEXT. When FNAME reads one of those special events, it does the scrolling and then reads another event. When it reads an event that is not one of those few, and which has a binding in HELP-MAP, it executes that key's binding and then returns. The argument HELP-LINE should be a single-line summary of the alternatives in HELP-MAP. In the current version of Emacs, this argument is used only if you set the option `three-step-help' to `t'. This macro is used in the command `help-for-help' which is the binding of `C-h C-h'. - User Option: three-step-help If this variable is non-`nil', commands defined with `make-help-screen' display their HELP-LINE strings in the echo area at first, and display the longer HELP-TEXT strings only if the user types the help character again. Files ***** In Emacs, you can find, create, view, save, and otherwise work with files and file directories. This chapter describes most of the file-related functions of Emacs Lisp, but a few others are described in *Note Buffers::, and those related to backups and auto-saving are described in *Note Backups and Auto-Saving::. Many of the file functions take one or more arguments that are file names. A file name is actually a string. Most of these functions expand file name arguments by calling `expand-file-name', so that `~' is handled correctly, as are relative file names (including `../'). These functions don't recognize environment variable substitutions such as `$HOME'. *Note File Name Expansion::. Visiting Files ============== Visiting a file means reading a file into a buffer. Once this is done, we say that the buffer is "visiting" that file, and call the file "the visited file" of the buffer. A file and a buffer are two different things. A file is information recorded permanently in the computer (unless you delete it). A buffer, on the other hand, is information inside of Emacs that will vanish at the end of the editing session (or when you kill the buffer). Usually, a buffer contains information that you have copied from a file; then we say the buffer is visiting that file. The copy in the buffer is what you modify with editing commands. Such changes to the buffer do not change the file; therefore, to make the changes permanent, you must "save" the buffer, which means copying the altered buffer contents back into the file. In spite of the distinction between files and buffers, people often refer to a file when they mean a buffer and vice-versa. Indeed, we say, "I am editing a file," rather than, "I am editing a buffer that I will soon save as a file of the same name." Humans do not usually need to make the distinction explicit. When dealing with a computer program, however, it is good to keep the distinction in mind. Functions for Visiting Files ---------------------------- This section describes the functions normally used to visit files. For historical reasons, these functions have names starting with `find-' rather than `visit-'. *Note Buffer File Name::, for functions and variables that access the visited file name of a buffer or that find an existing buffer by its visited file name. In a Lisp program, if you want to look at the contents of a file but not alter it, the fastest way is to use `insert-file-contents' in a temporary buffer. Visiting the file is not necessary and takes longer. *Note Reading from Files::. - Command: find-file FILENAME This command selects a buffer visiting the file FILENAME, using an existing buffer if there is one, and otherwise creating a new buffer and reading the file into it. It also returns that buffer. The body of the `find-file' function is very simple and looks like this: (switch-to-buffer (find-file-noselect filename)) (See `switch-to-buffer' in *Note Displaying Buffers::.) When `find-file' is called interactively, it prompts for FILENAME in the minibuffer. - Function: find-file-noselect FILENAME &optional NOWARN RAWFILE This function is the guts of all the file-visiting functions. It finds or creates a buffer visiting the file FILENAME, and returns it. It uses an existing buffer if there is one, and otherwise creates a new buffer and reads the file into it. You may make the buffer current or display it in a window if you wish, but this function does not do so. When `find-file-noselect' uses an existing buffer, it first verifies that the file has not changed since it was last visited or saved in that buffer. If the file has changed, then this function asks the user whether to reread the changed file. If the user says `yes', any changes previously made in the buffer are lost. This function displays warning or advisory messages in various peculiar cases, unless the optional argument NOWARN is non-`nil'. For example, if it needs to create a buffer, and there is no file named FILENAME, it displays the message `New file' in the echo area, and leaves the buffer empty. The `find-file-noselect' function normally calls `after-find-file' after reading the file (*note Subroutines of Visiting::.). That function sets the buffer major mode, parses local variables, warns the user if there exists an auto-save file more recent than the file just visited, and finishes by running the functions in `find-file-hooks'. If the optional argument RAWFILE is non-`nil', then `after-find-file' is not called, and the `find-file-not-found-hooks' are not run in case of failure. What's more, a non-`nil' RAWFILE value suppresses coding system conversion (*note Coding Systems::.) and format conversion (*note Format Conversion::.). The `find-file-noselect' function returns the buffer that is visiting the file FILENAME. (find-file-noselect "/etc/fstab") => # - Command: find-file-other-window FILENAME This command selects a buffer visiting the file FILENAME, but does so in a window other than the selected window. It may use another existing window or split a window; see *Note Displaying Buffers::. When this command is called interactively, it prompts for FILENAME. - Command: find-file-read-only FILENAME This command selects a buffer visiting the file FILENAME, like `find-file', but it marks the buffer as read-only. *Note Read Only Buffers::, for related functions and variables. When this command is called interactively, it prompts for FILENAME. - Command: view-file FILENAME This command visits FILENAME using View mode, returning to the previous buffer when you exit View mode. View mode is a minor mode that provides commands to skim rapidly through the file, but does not let you modify the text. Entering View mode runs the normal hook `view-mode-hook'. *Note Hooks::. When `view-file' is called interactively, it prompts for FILENAME. - Variable: find-file-hooks The value of this variable is a list of functions to be called after a file is visited. The file's local-variables specification (if any) will have been processed before the hooks are run. The buffer visiting the file is current when the hook functions are run. This variable works just like a normal hook, but we think that renaming it would not be advisable. *Note Hooks::. - Variable: find-file-not-found-hooks The value of this variable is a list of functions to be called when `find-file' or `find-file-noselect' is passed a nonexistent file name. `find-file-noselect' calls these functions as soon as it detects a nonexistent file. It calls them in the order of the list, until one of them returns non-`nil'. `buffer-file-name' is already set up. This is not a normal hook because the values of the functions are used, and in many cases only some of the functions are called. Subroutines of Visiting ----------------------- The `find-file-noselect' function uses two important subroutines which are sometimes useful in user Lisp code: `create-file-buffer' and `after-find-file'. This section explains how to use them. - Function: create-file-buffer FILENAME This function creates a suitably named buffer for visiting FILENAME, and returns it. It uses FILENAME (sans directory) as the name if that name is free; otherwise, it appends a string such as `<2>' to get an unused name. See also *Note Creating Buffers::. *Please note:* `create-file-buffer' does *not* associate the new buffer with a file and does not select the buffer. It also does not use the default major mode. (create-file-buffer "foo") => # (create-file-buffer "foo") => #> (create-file-buffer "foo") => #> This function is used by `find-file-noselect'. It uses `generate-new-buffer' (*note Creating Buffers::.). - Function: after-find-file &optional ERROR WARN This function sets the buffer major mode, and parses local variables (*note Auto Major Mode::.). It is called by `find-file-noselect' and by the default revert function (*note Reverting::.). If reading the file got an error because the file does not exist, but its directory does exist, the caller should pass a non-`nil' value for ERROR. In that case, `after-find-file' issues a warning: `(New File)'. For more serious errors, the caller should usually not call `after-find-file'. If WARN is non-`nil', then this function issues a warning if an auto-save file exists and is more recent than the visited file. The last thing `after-find-file' does is call all the functions in the list `find-file-hooks'. Saving Buffers ============== When you edit a file in Emacs, you are actually working on a buffer that is visiting that file--that is, the contents of the file are copied into the buffer and the copy is what you edit. Changes to the buffer do not change the file until you "save" the buffer, which means copying the contents of the buffer into the file. - Command: save-buffer &optional BACKUP-OPTION This function saves the contents of the current buffer in its visited file if the buffer has been modified since it was last visited or saved. Otherwise it does nothing. `save-buffer' is responsible for making backup files. Normally, BACKUP-OPTION is `nil', and `save-buffer' makes a backup file only if this is the first save since visiting the file. Other values for BACKUP-OPTION request the making of backup files in other circumstances: * With an argument of 4 or 64, reflecting 1 or 3 `C-u''s, the `save-buffer' function marks this version of the file to be backed up when the buffer is next saved. * With an argument of 16 or 64, reflecting 2 or 3 `C-u''s, the `save-buffer' function unconditionally backs up the previous version of the file before saving it. - Command: save-some-buffers &optional SAVE-SILENTLY-P EXITING This command saves some modified file-visiting buffers. Normally it asks the user about each buffer. But if SAVE-SILENTLY-P is non-`nil', it saves all the file-visiting buffers without querying the user. The optional EXITING argument, if non-`nil', requests this function to offer also to save certain other buffers that are not visiting files. These are buffers that have a non-`nil' buffer-local value of `buffer-offer-save'. (A user who says yes to saving one of these is asked to specify a file name to use.) The `save-buffers-kill-emacs' function passes a non-`nil' value for this argument. - Command: write-file FILENAME This function writes the current buffer into file FILENAME, makes the buffer visit that file, and marks it not modified. Then it renames the buffer based on FILENAME, appending a string like `<2>' if necessary to make a unique buffer name. It does most of this work by calling `set-visited-file-name' (*note Buffer File Name::.) and `save-buffer'. Saving a buffer runs several hooks. It also performs format conversion (*note Format Conversion::.), and may save text properties in "annotations" (*note Saving Properties::.). - Variable: write-file-hooks The value of this variable is a list of functions to be called before writing out a buffer to its visited file. If one of them returns non-`nil', the file is considered already written and the rest of the functions are not called, nor is the usual code for writing the file executed. If a function in `write-file-hooks' returns non-`nil', it is responsible for making a backup file (if that is appropriate). To do so, execute the following code: (or buffer-backed-up (backup-buffer)) You might wish to save the file modes value returned by `backup-buffer' and use that to set the mode bits of the file that you write. This is what `save-buffer' normally does. The hook functions in `write-file-hooks' are also responsible for encoding the data (if desired): they must choose a suitable coding system (*note Lisp and Coding Systems::.), perform the encoding (*note Explicit Encoding::.), and set `last-coding-system-used' to the coding system that was used (*note Encoding and I/O::.). Do not make this variable buffer-local. To set up buffer-specific hook functions, use `write-contents-hooks' instead. Even though this is not a normal hook, you can use `add-hook' and `remove-hook' to manipulate the list. *Note Hooks::. - Variable: local-write-file-hooks This works just like `write-file-hooks', but it is intended to be made buffer-local in particular buffers, and used for hooks that pertain to the file name or the way the buffer contents were obtained. The variable is marked as a permanent local, so that changing the major mode does not alter a buffer-local value. This is convenient for packages that read "file" contents in special ways, and set up hooks to save the data in a corresponding way. - Variable: write-contents-hooks This works just like `write-file-hooks', but it is intended for hooks that pertain to the contents of the file, as opposed to hooks that pertain to where the file came from. Such hooks are usually set up by major modes, as buffer-local bindings for this variable. This variable automatically becomes buffer-local whenever it is set; switching to a new major mode always resets this variable. When you use `add-hooks' to add an element to this hook, you should *not* specify a non-`nil' LOCAL argument, since this variable is used *only* buffer-locally. - Variable: after-save-hook This normal hook runs after a buffer has been saved in its visited file. One use of this hook is in Fast Lock mode; it uses this hook to save the highlighting information in a cache file. - Variable: file-precious-flag If this variable is non-`nil', then `save-buffer' protects against I/O errors while saving by writing the new file to a temporary name instead of the name it is supposed to have, and then renaming it to the intended name after it is clear there are no errors. This procedure prevents problems such as a lack of disk space from resulting in an invalid file. As a side effect, backups are necessarily made by copying. *Note Rename or Copy::. Yet, at the same time, saving a precious file always breaks all hard links between the file you save and other file names. Some modes give this variable a non-`nil' buffer-local value in particular buffers. - User Option: require-final-newline This variable determines whether files may be written out that do *not* end with a newline. If the value of the variable is `t', then `save-buffer' silently adds a newline at the end of the file whenever the buffer being saved does not already end in one. If the value of the variable is non-`nil', but not `t', then `save-buffer' asks the user whether to add a newline each time the case arises. If the value of the variable is `nil', then `save-buffer' doesn't add newlines at all. `nil' is the default value, but a few major modes set it to `t' in particular buffers. See also the function `set-visited-file-name' (*note Buffer File Name::.). Reading from Files ================== You can copy a file from the disk and insert it into a buffer using the `insert-file-contents' function. Don't use the user-level command `insert-file' in a Lisp program, as that sets the mark. - Function: insert-file-contents FILENAME &optional VISIT BEG END REPLACE This function inserts the contents of file FILENAME into the current buffer after point. It returns a list of the absolute file name and the length of the data inserted. An error is signaled if FILENAME is not the name of a file that can be read. The function `insert-file-contents' checks the file contents against the defined file formats, and converts the file contents if appropriate. *Note Format Conversion::. It also calls the functions in the list `after-insert-file-functions'; see *Note Saving Properties::. If VISIT is non-`nil', this function additionally marks the buffer as unmodified and sets up various fields in the buffer so that it is visiting the file FILENAME: these include the buffer's visited file name and its last save file modtime. This feature is used by `find-file-noselect' and you probably should not use it yourself. If BEG and END are non-`nil', they should be integers specifying the portion of the file to insert. In this case, VISIT must be `nil'. For example, (insert-file-contents filename nil 0 500) inserts the first 500 characters of a file. If the argument REPLACE is non-`nil', it means to replace the contents of the buffer (actually, just the accessible portion) with the contents of the file. This is better than simply deleting the buffer contents and inserting the whole file, because (1) it preserves some marker positions and (2) it puts less data in the undo list. It is possible to read a special file (such as a FIFO or an I/O device) with `insert-file-contents', as long as REPLACE and VISIT are `nil'. - Function: insert-file-contents-literally FILENAME &optional VISIT BEG END REPLACE This function works like `insert-file-contents' except that it does not do format decoding (*note Format Conversion::.), does not do character code conversion (*note Coding Systems::.), does not run `find-file-hooks', does not perform automatic uncompression, and so on. If you want to pass a file name to another process so that another program can read the file, use the function `file-local-copy'; see *Note Magic File Names::. Writing to Files ================ You can write the contents of a buffer, or part of a buffer, directly to a file on disk using the `append-to-file' and `write-region' functions. Don't use these functions to write to files that are being visited; that could cause confusion in the mechanisms for visiting. - Command: append-to-file START END FILENAME This function appends the contents of the region delimited by START and END in the current buffer to the end of file FILENAME. If that file does not exist, it is created. This function returns `nil'. An error is signaled if FILENAME specifies a nonwritable file, or a nonexistent file in a directory where files cannot be created. - Command: write-region START END FILENAME &optional APPEND VISIT CONFIRM This function writes the region delimited by START and END in the current buffer into the file specified by FILENAME. If START is a string, then `write-region' writes or appends that string, rather than text from the buffer. If APPEND is non-`nil', then the specified text is appended to the existing file contents (if any). If CONFIRM is non-`nil', then `write-region' asks for confirmation if FILENAME names an existing file. If VISIT is `t', then Emacs establishes an association between the buffer and the file: the buffer is then visiting that file. It also sets the last file modification time for the current buffer to FILENAME's modtime, and marks the buffer as not modified. This feature is used by `save-buffer', but you probably should not use it yourself. If VISIT is a string, it specifies the file name to visit. This way, you can write the data to one file (FILENAME) while recording the buffer as visiting another file (VISIT). The argument VISIT is used in the echo area message and also for file locking; VISIT is stored in `buffer-file-name'. This feature is used to implement `file-precious-flag'; don't use it yourself unless you really know what you're doing. The function `write-region' converts the data which it writes to the appropriate file formats specified by `buffer-file-format'. *Note Format Conversion::. It also calls the functions in the list `write-region-annotate-functions'; see *Note Saving Properties::. Normally, `write-region' displays the message `Wrote FILENAME' in the echo area. If VISIT is neither `t' nor `nil' nor a string, then this message is inhibited. This feature is useful for programs that use files for internal purposes, files that the user does not need to know about. - Macro: with-temp-file FILE BODY... The `with-temp-file' macro evaluates the BODY forms with a temporary buffer as the current buffer; then, at the end, it writes the buffer contents into file FILE. It kills the temporary buffer when finished, restoring the buffer that was current before the `with-temp-file' form. Then it returns the value of the last form in BODY. The current buffer is restored even in case of an abnormal exit via `throw' or error (*note Nonlocal Exits::.). See also `with-temp-buffer' in *Note Current Buffer::. File Locks ========== When two users edit the same file at the same time, they are likely to interfere with each other. Emacs tries to prevent this situation from arising by recording a "file lock" when a file is being modified. Emacs can then detect the first attempt to modify a buffer visiting a file that is locked by another Emacs job, and ask the user what to do. File locks are not completely reliable when multiple machines can share file systems. When file locks do not work, it is possible for two users to make changes simultaneously, but Emacs can still warn the user who saves second. Also, the detection of modification of a buffer visiting a file changed on disk catches some cases of simultaneous editing; see *Note Modification Time::. - Function: file-locked-p FILENAME This function returns `nil' if the file FILENAME is not locked. It returns `t' if it is locked by this Emacs process, and it returns the name of the user who has locked it if it is locked by some other job. (file-locked-p "foo") => nil - Function: lock-buffer &optional FILENAME This function locks the file FILENAME, if the current buffer is modified. The argument FILENAME defaults to the current buffer's visited file. Nothing is done if the current buffer is not visiting a file, or is not modified. - Function: unlock-buffer This function unlocks the file being visited in the current buffer, if the buffer is modified. If the buffer is not modified, then the file should not be locked, so this function does nothing. It also does nothing if the current buffer is not visiting a file. - Function: ask-user-about-lock FILE OTHER-USER This function is called when the user tries to modify FILE, but it is locked by another user named OTHER-USER. The default definition of this function asks the user to say what to do. The value this function returns determines what Emacs does next: * A value of `t' says to grab the lock on the file. Then this user may edit the file and OTHER-USER loses the lock. * A value of `nil' says to ignore the lock and let this user edit the file anyway. * This function may instead signal a `file-locked' error, in which case the change that the user was about to make does not take place. The error message for this error looks like this: error--> File is locked: FILE OTHER-USER where `file' is the name of the file and OTHER-USER is the name of the user who has locked the file. If you wish, you can replace the `ask-user-about-lock' function with your own version that makes the decision in another way. The code for its usual definition is in `userlock.el'. Information about Files ======================= The functions described in this section all operate on strings that designate file names. All the functions have names that begin with the word `file'. These functions all return information about actual files or directories, so their arguments must all exist as actual files or directories unless otherwise noted. Testing Accessibility --------------------- These functions test for permission to access a file in specific ways. - Function: file-exists-p FILENAME This function returns `t' if a file named FILENAME appears to exist. This does not mean you can necessarily read the file, only that you can find out its attributes. (On Unix, this is true if the file exists and you have execute permission on the containing directories, regardless of the protection of the file itself.) If the file does not exist, or if fascist access control policies prevent you from finding the attributes of the file, this function returns `nil'. - Function: file-readable-p FILENAME This function returns `t' if a file named FILENAME exists and you can read it. It returns `nil' otherwise. (file-readable-p "files.texi") => t (file-exists-p "/usr/spool/mqueue") => t (file-readable-p "/usr/spool/mqueue") => nil - Function: file-executable-p FILENAME This function returns `t' if a file named FILENAME exists and you can execute it. It returns `nil' otherwise. If the file is a directory, execute permission means you can check the existence and attributes of files inside the directory, and open those files if their modes permit. - Function: file-writable-p FILENAME This function returns `t' if the file FILENAME can be written or created by you, and `nil' otherwise. A file is writable if the file exists and you can write it. It is creatable if it does not exist, but the specified directory does exist and you can write in that directory. In the third example below, `foo' is not writable because the parent directory does not exist, even though the user could create such a directory. (file-writable-p "~/foo") => t (file-writable-p "/foo") => nil (file-writable-p "~/no-such-dir/foo") => nil - Function: file-accessible-directory-p DIRNAME This function returns `t' if you have permission to open existing files in the directory whose name as a file is DIRNAME; otherwise (or if there is no such directory), it returns `nil'. The value of DIRNAME may be either a directory name or the file name of a file which is a directory. Example: after the following, (file-accessible-directory-p "/foo") => nil we can deduce that any attempt to read a file in `/foo/' will give an error. - Function: access-file FILENAME STRING This function opens file FILENAME for reading, then closes it and returns `nil'. However, if the open fails, it signals an error using STRING as the error message text. - Function: file-ownership-preserved-p FILENAME This function returns `t' if deleting the file FILENAME and then creating it anew would keep the file's owner unchanged. - Function: file-newer-than-file-p FILENAME1 FILENAME2 This function returns `t' if the file FILENAME1 is newer than file FILENAME2. If FILENAME1 does not exist, it returns `nil'. If FILENAME2 does not exist, it returns `t'. In the following example, assume that the file `aug-19' was written on the 19th, `aug-20' was written on the 20th, and the file `no-file' doesn't exist at all. (file-newer-than-file-p "aug-19" "aug-20") => nil (file-newer-than-file-p "aug-20" "aug-19") => t (file-newer-than-file-p "aug-19" "no-file") => t (file-newer-than-file-p "no-file" "aug-19") => nil You can use `file-attributes' to get a file's last modification time as a list of two numbers. *Note File Attributes::. Distinguishing Kinds of Files ----------------------------- This section describes how to distinguish various kinds of files, such as directories, symbolic links, and ordinary files. - Function: file-symlink-p FILENAME If the file FILENAME is a symbolic link, the `file-symlink-p' function returns the file name to which it is linked. This may be the name of a text file, a directory, or even another symbolic link, or it may be a nonexistent file name. If the file FILENAME is not a symbolic link (or there is no such file), `file-symlink-p' returns `nil'. (file-symlink-p "foo") => nil (file-symlink-p "sym-link") => "foo" (file-symlink-p "sym-link2") => "sym-link" (file-symlink-p "/bin") => "/pub/bin" - Function: file-directory-p FILENAME This function returns `t' if FILENAME is the name of an existing directory, `nil' otherwise. (file-directory-p "~rms") => t (file-directory-p "~rms/lewis/files.texi") => nil (file-directory-p "~rms/lewis/no-such-file") => nil (file-directory-p "$HOME") => nil (file-directory-p (substitute-in-file-name "$HOME")) => t - Function: file-regular-p FILENAME This function returns `t' if the file FILENAME exists and is a regular file (not a directory, symbolic link, named pipe, terminal, or other I/O device). Truenames --------- The "truename" of a file is the name that you get by following symbolic links until none remain, then simplifying away `.' and `..' appearing as components. Strictly speaking, a file need not have a unique truename; the number of distinct truenames a file has is equal to the number of hard links to the file. However, truenames are useful because they eliminate symbolic links as a cause of name variation. - Function: file-truename FILENAME The function `file-truename' returns the true name of the file FILENAME. This is the name that you get by following symbolic links until none remain. The argument must be an absolute file name. *Note Buffer File Name::, for related information. Other Information about Files ----------------------------- This section describes the functions for getting detailed information about a file, other than its contents. This information includes the mode bits that control access permission, the owner and group numbers, the number of names, the inode number, the size, and the times of access and modification. - Function: file-modes FILENAME This function returns the mode bits of FILENAME, as an integer. The mode bits are also called the file permissions, and they specify access control in the usual Unix fashion. If the low-order bit is 1, then the file is executable by all users, if the second-lowest-order bit is 1, then the file is writable by all users, etc. The highest value returnable is 4095 (7777 octal), meaning that everyone has read, write, and execute permission, that the SUID bit is set for both others and group, and that the sticky bit is set. (file-modes "~/junk/diffs") => 492 ; Decimal integer. (format "%o" 492) => "754" ; Convert to octal. (set-file-modes "~/junk/diffs" 438) => nil (format "%o" 438) => "666" ; Convert to octal. % ls -l diffs -rw-rw-rw- 1 lewis 0 3063 Oct 30 16:00 diffs - Function: file-nlinks FILENAME This functions returns the number of names (i.e., hard links) that file FILENAME has. If the file does not exist, then this function returns `nil'. Note that symbolic links have no effect on this function, because they are not considered to be names of the files they link to. % ls -l foo* -rw-rw-rw- 2 rms 4 Aug 19 01:27 foo -rw-rw-rw- 2 rms 4 Aug 19 01:27 foo1 (file-nlinks "foo") => 2 (file-nlinks "doesnt-exist") => nil - Function: file-attributes FILENAME This function returns a list of attributes of file FILENAME. If the specified file cannot be opened, it returns `nil'. The elements of the list, in order, are: 0. `t' for a directory, a string for a symbolic link (the name linked to), or `nil' for a text file. 1. The number of names the file has. Alternate names, also known as hard links, can be created by using the `add-name-to-file' function (*note Changing Files::.). 2. The file's UID. 3. The file's GID. 4. The time of last access, as a list of two integers. The first integer has the high-order 16 bits of time, the second has the low 16 bits. (This is similar to the value of `current-time'; see *Note Time of Day::.) 5. The time of last modification as a list of two integers (as above). 6. The time of last status change as a list of two integers (as above). 7. The size of the file in bytes. 8. The file's modes, as a string of ten letters or dashes, as in `ls -l'. 9. `t' if the file's GID would change if file were deleted and recreated; `nil' otherwise. 10. The file's inode number. If possible, this is an integer. If the inode number is too large to be represented as an integer in Emacs Lisp, then the value has the form `(HIGH . LOW)', where LOW holds the low 16 bits. 11. The file system number of the file system that the file is in. This element and the file's inode number together give enough information to distinguish any two files on the system--no two files can have the same values for both of these numbers. For example, here are the file attributes for `files.texi': (file-attributes "files.texi") => (nil 1 2235 75 (8489 20284) (8489 20284) (8489 20285) 14906 "-rw-rw-rw-" nil 129500 -32252) and here is how the result is interpreted: `nil' is neither a directory nor a symbolic link. `1' has only one name (the name `files.texi' in the current default directory). `2235' is owned by the user with UID 2235. `75' is in the group with GID 75. `(8489 20284)' was last accessed on Aug 19 00:09. `(8489 20284)' was last modified on Aug 19 00:09. `(8489 20285)' last had its inode changed on Aug 19 00:09. `14906' is 14906 characters long. `"-rw-rw-rw-"' has a mode of read and write access for the owner, group, and world. `nil' would retain the same GID if it were recreated. `129500' has an inode number of 129500. `-32252' is on file system number -32252. Changing File Names and Attributes ================================== The functions in this section rename, copy, delete, link, and set the modes of files. In the functions that have an argument NEWNAME, if a file by the name of NEWNAME already exists, the actions taken depend on the value of the argument OK-IF-ALREADY-EXISTS: * Signal a `file-already-exists' error if OK-IF-ALREADY-EXISTS is `nil'. * Request confirmation if OK-IF-ALREADY-EXISTS is a number. * Replace the old file without confirmation if OK-IF-ALREADY-EXISTS is any other value. - Function: add-name-to-file OLDNAME NEWNAME &optional OK-IF-ALREADY-EXISTS This function gives the file named OLDNAME the additional name NEWNAME. This means that NEWNAME becomes a new "hard link" to OLDNAME. In the first part of the following example, we list two files, `foo' and `foo3'. % ls -li fo* 81908 -rw-rw-rw- 1 rms 29 Aug 18 20:32 foo 84302 -rw-rw-rw- 1 rms 24 Aug 18 20:31 foo3 Now we create a hard link, by calling `add-name-to-file', then list the files again. This shows two names for one file, `foo' and `foo2'. (add-name-to-file "foo" "foo2") => nil % ls -li fo* 81908 -rw-rw-rw- 2 rms 29 Aug 18 20:32 foo 81908 -rw-rw-rw- 2 rms 29 Aug 18 20:32 foo2 84302 -rw-rw-rw- 1 rms 24 Aug 18 20:31 foo3 Finally, we evaluate the following: (add-name-to-file "foo" "foo3" t) and list the files again. Now there are three names for one file: `foo', `foo2', and `foo3'. The old contents of `foo3' are lost. (add-name-to-file "foo1" "foo3") => nil % ls -li fo* 81908 -rw-rw-rw- 3 rms 29 Aug 18 20:32 foo 81908 -rw-rw-rw- 3 rms 29 Aug 18 20:32 foo2 81908 -rw-rw-rw- 3 rms 29 Aug 18 20:32 foo3 This function is meaningless on operating systems where multiple names for one file are not allowed. See also `file-nlinks' in *Note File Attributes::. - Command: rename-file FILENAME NEWNAME &optional OK-IF-ALREADY-EXISTS This command renames the file FILENAME as NEWNAME. If FILENAME has additional names aside from FILENAME, it continues to have those names. In fact, adding the name NEWNAME with `add-name-to-file' and then deleting FILENAME has the same effect as renaming, aside from momentary intermediate states. In an interactive call, this function prompts for FILENAME and NEWNAME in the minibuffer; also, it requests confirmation if NEWNAME already exists. - Command: copy-file OLDNAME NEWNAME &optional OK-IF-EXISTS TIME This command copies the file OLDNAME to NEWNAME. An error is signaled if OLDNAME does not exist. If TIME is non-`nil', then this function gives the new file the same last-modified time that the old one has. (This works on only some operating systems.) If setting the time gets an error, `copy-file' signals a `file-date-error' error. In an interactive call, this function prompts for FILENAME and NEWNAME in the minibuffer; also, it requests confirmation if NEWNAME already exists. - Command: delete-file FILENAME This command deletes the file FILENAME, like the shell command `rm FILENAME'. If the file has multiple names, it continues to exist under the other names. A suitable kind of `file-error' error is signaled if the file does not exist, or is not deletable. (On Unix, a file is deletable if its directory is writable.) See also `delete-directory' in *Note Create/Delete Dirs::. - Command: make-symbolic-link FILENAME NEWNAME &optional OK-IF-EXISTS This command makes a symbolic link to FILENAME, named NEWNAME. This is like the shell command `ln -s FILENAME NEWNAME'. In an interactive call, this function prompts for FILENAME and NEWNAME in the minibuffer; also, it requests confirmation if NEWNAME already exists. - Function: define-logical-name VARNAME STRING This function defines the logical name NAME to have the value STRING. It is available only on VMS. - Function: set-file-modes FILENAME MODE This function sets mode bits of FILENAME to MODE (which must be an integer). Only the low 12 bits of MODE are used. - Function: set-default-file-modes MODE This function sets the default file protection for new files created by Emacs and its subprocesses. Every file created with Emacs initially has this protection. On Unix, the default protection is the bitwise complement of the "umask" value. The argument MODE must be an integer. On most systems, only the low 9 bits of MODE are meaningful. Saving a modified version of an existing file does not count as creating the file; it does not change the file's mode, and does not use the default file protection. - Function: default-file-modes This function returns the current default protection value. On MS-DOS, there is no such thing as an "executable" file mode bit. So Emacs considers a file executable if its name ends in `.com', `.bat' or `.exe'. This is reflected in the values returned by `file-modes' and `file-attributes'. File Names ========== Files are generally referred to by their names, in Emacs as elsewhere. File names in Emacs are represented as strings. The functions that operate on a file all expect a file name argument. In addition to operating on files themselves, Emacs Lisp programs often need to operate on file names; i.e., to take them apart and to use part of a name to construct related file names. This section describes how to manipulate file names. The functions in this section do not actually access files, so they can operate on file names that do not refer to an existing file or directory. On VMS, all these functions understand both VMS file-name syntax and Unix syntax. This is so that all the standard Lisp libraries can specify file names in Unix syntax and work properly on VMS without change. On MS-DOS and MS-Windows, these functions understand MS-DOS or MS-Windows file-name syntax as well as Unix syntax. File Name Components -------------------- The operating system groups files into directories. To specify a file, you must specify the directory and the file's name within that directory. Therefore, Emacs considers a file name as having two main parts: the "directory name" part, and the "nondirectory" part (or "file name within the directory"). Either part may be empty. Concatenating these two parts reproduces the original file name. On Unix, the directory part is everything up to and including the last slash; the nondirectory part is the rest. The rules in VMS syntax are complicated. For some purposes, the nondirectory part is further subdivided into the name proper and the "version number". On Unix, only backup files have version numbers in their names. On VMS, every file has a version number, but most of the time the file name actually used in Emacs omits the version number, so that version numbers in Emacs are found mostly in directory lists. - Function: file-name-directory FILENAME This function returns the directory part of FILENAME (or `nil' if FILENAME does not include a directory part). On Unix, the function returns a string ending in a slash. On VMS, it returns a string ending in one of the three characters `:', `]', or `>'. (file-name-directory "lewis/foo") ; Unix example => "lewis/" (file-name-directory "foo") ; Unix example => nil (file-name-directory "[X]FOO.TMP") ; VMS example => "[X]" - Function: file-name-nondirectory FILENAME This function returns the nondirectory part of FILENAME. (file-name-nondirectory "lewis/foo") => "foo" (file-name-nondirectory "foo") => "foo" ;; The following example is accurate only on VMS. (file-name-nondirectory "[X]FOO.TMP") => "FOO.TMP" - Function: file-name-sans-versions FILENAME This function returns FILENAME with any file version numbers, backup version numbers, or trailing tildes deleted. (file-name-sans-versions "~rms/foo.~1~") => "~rms/foo" (file-name-sans-versions "~rms/foo~") => "~rms/foo" (file-name-sans-versions "~rms/foo") => "~rms/foo" ;; The following example applies to VMS only. (file-name-sans-versions "foo;23") => "foo" - Function: file-name-sans-extension FILENAME This function returns FILENAME minus its "extension," if any. The extension, in a file name, is the part that starts with the last `.' in the last name component. For example, (file-name-sans-extension "foo.lose.c") => "foo.lose" (file-name-sans-extension "big.hack/foo") => "big.hack/foo" Directory Names --------------- A "directory name" is the name of a directory. A directory is a kind of file, and it has a file name, which is related to the directory name but not identical to it. (This is not quite the same as the usual Unix terminology.) These two different names for the same entity are related by a syntactic transformation. On Unix, this is simple: a directory name ends in a slash, whereas the directory's name as a file lacks that slash. On VMS, the relationship is more complicated. The difference between a directory name and its name as a file is subtle but crucial. When an Emacs variable or function argument is described as being a directory name, a file name of a directory is not acceptable. The following two functions convert between directory names and file names. They do nothing special with environment variable substitutions such as `$HOME', and the constructs `~', and `..'. - Function: file-name-as-directory FILENAME This function returns a string representing FILENAME in a form that the operating system will interpret as the name of a directory. In Unix, this means appending a slash to the string (if it does not already end in one). On VMS, the function converts a string of the form `[X]Y.DIR.1' to the form `[X.Y]'. (file-name-as-directory "~rms/lewis") => "~rms/lewis/" - Function: directory-file-name DIRNAME This function returns a string representing DIRNAME in a form that the operating system will interpret as the name of a file. On Unix, this means removing the final slash from the string. On VMS, the function converts a string of the form `[X.Y]' to `[X]Y.DIR.1'. (directory-file-name "~lewis/") => "~lewis" Directory name abbreviations are useful for directories that are normally accessed through symbolic links. Sometimes the users recognize primarily the link's name as "the name" of the directory, and find it annoying to see the directory's "real" name. If you define the link name as an abbreviation for the "real" name, Emacs shows users the abbreviation instead. - Variable: directory-abbrev-alist The variable `directory-abbrev-alist' contains an alist of abbreviations to use for file directories. Each element has the form `(FROM . TO)', and says to replace FROM with TO when it appears in a directory name. The FROM string is actually a regular expression; it should always start with `^'. The function `abbreviate-file-name' performs these substitutions. You can set this variable in `site-init.el' to describe the abbreviations appropriate for your site. Here's an example, from a system on which file system `/home/fsf' and so on are normally accessed through symbolic links named `/fsf' and so on. (("^/home/fsf" . "/fsf") ("^/home/gp" . "/gp") ("^/home/gd" . "/gd")) To convert a directory name to its abbreviation, use this function: - Function: abbreviate-file-name DIRNAME This function applies abbreviations from `directory-abbrev-alist' to its argument, and substitutes `~' for the user's home directory. Absolute and Relative File Names -------------------------------- All the directories in the file system form a tree starting at the root directory. A file name can specify all the directory names starting from the root of the tree; then it is called an "absolute" file name. Or it can specify the position of the file in the tree relative to a default directory; then it is called a "relative" file name. On Unix, an absolute file name starts with a slash or a tilde (`~'), and a relative one does not. The rules on VMS are complicated. - Function: file-name-absolute-p FILENAME This function returns `t' if file FILENAME is an absolute file name, `nil' otherwise. On VMS, this function understands both Unix syntax and VMS syntax. (file-name-absolute-p "~rms/foo") => t (file-name-absolute-p "rms/foo") => nil (file-name-absolute-p "/user/rms/foo") => t Functions that Expand Filenames ------------------------------- "Expansion" of a file name means converting a relative file name to an absolute one. Since this is done relative to a default directory, you must specify the default directory name as well as the file name to be expanded. Expansion also simplifies file names by eliminating redundancies such as `./' and `NAME/../'. - Function: expand-file-name FILENAME &optional DIRECTORY This function converts FILENAME to an absolute file name. If DIRECTORY is supplied, it is the default directory to start with if FILENAME is relative. (The value of DIRECTORY should itself be an absolute directory name; it may start with `~'.) Otherwise, the current buffer's value of `default-directory' is used. For example: (expand-file-name "foo") => "/xcssun/users/rms/lewis/foo" (expand-file-name "../foo") => "/xcssun/users/rms/foo" (expand-file-name "foo" "/usr/spool/") => "/usr/spool/foo" (expand-file-name "$HOME/foo") => "/xcssun/users/rms/lewis/$HOME/foo" Filenames containing `.' or `..' are simplified to their canonical form: (expand-file-name "bar/../foo") => "/xcssun/users/rms/lewis/foo" Note that `expand-file-name' does *not* expand environment variables; only `substitute-in-file-name' does that. - Function: file-relative-name FILENAME DIRECTORY This function does the inverse of expansion--it tries to return a relative name that is equivalent to FILENAME when interpreted relative to DIRECTORY. On some operating systems, an absolute file name begins with a device name. On such systems, FILENAME has no relative equivalent based on DIRECTORY if they start with two different device names. In this case, `file-relative-name' returns FILENAME in absolute form. (file-relative-name "/foo/bar" "/foo/") => "bar" (file-relative-name "/foo/bar" "/hack/") => "/foo/bar" - Variable: default-directory The value of this buffer-local variable is the default directory for the current buffer. It should be an absolute directory name; it may start with `~'. This variable is buffer-local in every buffer. `expand-file-name' uses the default directory when its second argument is `nil'. On Unix systems, the value is always a string ending with a slash. default-directory => "/user/lewis/manual/" - Function: substitute-in-file-name FILENAME This function replaces environment variables references in FILENAME with the environment variable values. Following standard Unix shell syntax, `$' is the prefix to substitute an environment variable value. The environment variable name is the series of alphanumeric characters (including underscores) that follow the `$'. If the character following the `$' is a `{', then the variable name is everything up to the matching `}'. Here we assume that the environment variable `HOME', which holds the user's home directory name, has value `/xcssun/users/rms'. (substitute-in-file-name "$HOME/foo") => "/xcssun/users/rms/foo" After substitution, if a `~' or a `/' appears following a `/', everything before the following `/' is discarded: (substitute-in-file-name "bar/~/foo") => "~/foo" (substitute-in-file-name "/usr/local/$HOME/foo") => "/xcssun/users/rms/foo" ;; `/usr/local/' has been discarded. On VMS, `$' substitution is not done, so this function does nothing on VMS except discard superfluous initial components as shown above. Generating Unique File Names ---------------------------- Some programs need to write temporary files. Here is the usual way to construct a name for such a file: (make-temp-name (expand-file-name NAME-OF-APPLICATION temporary-file-directory)) The job of `make-temp-name' is to prevent two different users or two different jobs from trying to use the exact same file name. This example uses the variable `temporary-file-directory' to decide where to put the temporary file. All Emacs Lisp programs should use `temporary-file-directory' for this purpose, to give the user a uniform way to specify the directory for all temporary files. - Function: make-temp-name STRING This function generates a string that can be used as a unique file name. The name starts with STRING, and contains a number that is different in each Emacs job. (make-temp-name "/tmp/foo") => "/tmp/foo232J6v" To prevent conflicts among different libraries running in the same Emacs, each Lisp program that uses `make-temp-name' should have its own STRING. The number added to the end of STRING distinguishes between the same application running in different Emacs jobs. Additional added characters permit a large number of distinct names even in one Emacs job. - Variable: temporary-file-directory This variable specifies the directory name for creating temporary files. Its value should be a directory name (*note Directory Names::.), but it is good for Lisp programs to cope if the value is a directory's file name instead. Using the value as the second argument to `expand-file-name' is a good way to achieve that. The default value is determined in a reasonable way for your operating system; on GNU and Unix systems it is based on the `TMP' and `TMPDIR' environment variables. Even if you do not use `make-temp-name' to choose the temporary file's name, you should still use this variable to decide which directory to put the file in. File Name Completion -------------------- This section describes low-level subroutines for completing a file name. For other completion functions, see *Note Completion::. - Function: file-name-all-completions PARTIAL-FILENAME DIRECTORY This function returns a list of all possible completions for a file whose name starts with PARTIAL-FILENAME in directory DIRECTORY. The order of the completions is the order of the files in the directory, which is unpredictable and conveys no useful information. The argument PARTIAL-FILENAME must be a file name containing no directory part and no slash. The current buffer's default directory is prepended to DIRECTORY, if DIRECTORY is not absolute. In the following example, suppose that `~rms/lewis' is the current default directory, and has five files whose names begin with `f': `foo', `file~', `file.c', `file.c.~1~', and `file.c.~2~'. (file-name-all-completions "f" "") => ("foo" "file~" "file.c.~2~" "file.c.~1~" "file.c") (file-name-all-completions "fo" "") => ("foo") - Function: file-name-completion FILENAME DIRECTORY This function completes the file name FILENAME in directory DIRECTORY. It returns the longest prefix common to all file names in directory DIRECTORY that start with FILENAME. If only one match exists and FILENAME matches it exactly, the function returns `t'. The function returns `nil' if directory DIRECTORY contains no name starting with FILENAME. In the following example, suppose that the current default directory has five files whose names begin with `f': `foo', `file~', `file.c', `file.c.~1~', and `file.c.~2~'. (file-name-completion "fi" "") => "file" (file-name-completion "file.c.~1" "") => "file.c.~1~" (file-name-completion "file.c.~1~" "") => t (file-name-completion "file.c.~3" "") => nil - User Option: completion-ignored-extensions `file-name-completion' usually ignores file names that end in any string in this list. It does not ignore them when all the possible completions end in one of these suffixes or when a buffer showing all possible completions is displayed. A typical value might look like this: completion-ignored-extensions => (".o" ".elc" "~" ".dvi") Standard File Names ------------------- Most of the file names used in Lisp programs are entered by the user. But occasionally a Lisp program needs to specify a standard file name for a particular use--typically, to hold customization information about each user. For example, abbrev definitions are stored (by default) in the file `~/.abbrev_defs'; the `completion' package stores completions in the file `~/.completions'. These are two of the many standard file names used by parts of Emacs for certain purposes. Various operating systems have their own conventions for valid file names and for which file names to use for user profile data. A Lisp program which reads a file using a standard file name ought to use, on each type of system, a file name suitable for that system. The function `convert-standard-filename' makes this easy to do. - Function: convert-standard-filename FILENAME This function alters the file name FILENAME to fit the conventions of the operating system in use, and returns the result as a new string. The recommended way to specify a standard file name in a Lisp program is to choose a name which fits the conventions of GNU and Unix systems, usually with a nondirectory part that starts with a period, and pass it to `convert-standard-filename' instead of using it directly. Here is an example from the `completion' package: (defvar save-completions-file-name (convert-standard-filename "~/.completions") "*The file name to save completions to.") On GNU and Unix systems, and on some other systems as well, `convert-standard-filename' returns its argument unchanged. On some other systems, it alters the name to fit the system's conventions. For example, on MS-DOS the alterations made by this function include converting a leading `.' to `_', converting a `_' in the middle of the name to `.' if there is no other `.', inserting a `.' after eight characters if there is none, and truncating to three characters after the `.'. (It makes other changes as well.) Thus, `.abbrev_defs' becomes `_abbrev.def', and `.completions' becomes `_complet.ion'. Contents of Directories ======================= A directory is a kind of file that contains other files entered under various names. Directories are a feature of the file system. Emacs can list the names of the files in a directory as a Lisp list, or display the names in a buffer using the `ls' shell command. In the latter case, it can optionally display information about each file, depending on the options passed to the `ls' command. - Function: directory-files DIRECTORY &optional FULL-NAME MATCH-REGEXP NOSORT This function returns a list of the names of the files in the directory DIRECTORY. By default, the list is in alphabetical order. If FULL-NAME is non-`nil', the function returns the files' absolute file names. Otherwise, it returns the names relative to the specified directory. If MATCH-REGEXP is non-`nil', this function returns only those file names that contain a match for that regular expression--the other file names are excluded from the list. If NOSORT is non-`nil', `directory-files' does not sort the list, so you get the file names in no particular order. Use this if you want the utmost possible speed and don't care what order the files are processed in. If the order of processing is visible to the user, then the user will probably be happier if you do sort the names. (directory-files "~lewis") => ("#foo#" "#foo.el#" "." ".." "dired-mods.el" "files.texi" "files.texi.~1~") An error is signaled if DIRECTORY is not the name of a directory that can be read. - Function: file-name-all-versions FILE DIRNAME This function returns a list of all versions of the file named FILE in directory DIRNAME. - Function: insert-directory FILE SWITCHES &optional WILDCARD FULL-DIRECTORY-P This function inserts (in the current buffer) a directory listing for directory FILE, formatted with `ls' according to SWITCHES. It leaves point after the inserted text. The argument FILE may be either a directory name or a file specification including wildcard characters. If WILDCARD is non-`nil', that means treat FILE as a file specification with wildcards. If FULL-DIRECTORY-P is non-`nil', that means the directory listing is expected to show the full contents of a directory. You should specify `t' when FILE is a directory and switches do not contain `-d'. (The `-d' option to `ls' says to describe a directory itself as a file, rather than showing its contents.) This function works by running a directory listing program whose name is in the variable `insert-directory-program'. If WILDCARD is non-`nil', it also runs the shell specified by `shell-file-name', to expand the wildcards. - Variable: insert-directory-program This variable's value is the program to run to generate a directory listing for the function `insert-directory'. Creating and Deleting Directories ================================= Most Emacs Lisp file-manipulation functions get errors when used on files that are directories. For example, you cannot delete a directory with `delete-file'. These special functions exist to create and delete directories. - Function: make-directory DIRNAME This function creates a directory named DIRNAME. - Function: delete-directory DIRNAME This function deletes the directory named DIRNAME. The function `delete-file' does not work for files that are directories; you must use `delete-directory' for them. If the directory contains any files, `delete-directory' signals an error. Making Certain File Names "Magic" ================================= You can implement special handling for certain file names. This is called making those names "magic". The principal use for this feature is in implementing remote file names (*note Remote Files: (emacs)Remote Files.). To define a kind of magic file name, you must supply a regular expression to define the class of names (all those that match the regular expression), plus a handler that implements all the primitive Emacs file operations for file names that do match. The variable `file-name-handler-alist' holds a list of handlers, together with regular expressions that determine when to apply each handler. Each element has this form: (REGEXP . HANDLER) All the Emacs primitives for file access and file name transformation check the given file name against `file-name-handler-alist'. If the file name matches REGEXP, the primitives handle that file by calling HANDLER. The first argument given to HANDLER is the name of the primitive; the remaining arguments are the arguments that were passed to that operation. (The first of these arguments is typically the file name itself.) For example, if you do this: (file-exists-p FILENAME) and FILENAME has handler HANDLER, then HANDLER is called like this: (funcall HANDLER 'file-exists-p FILENAME) Here are the operations that a magic file name handler gets to handle: `add-name-to-file', `copy-file', `delete-directory', `delete-file', `diff-latest-backup-file', `directory-file-name', `directory-files', `dired-call-process', `dired-compress-file', `dired-uncache', `expand-file-name', `file-accessible-directory-p', `file-attributes', `file-directory-p', `file-executable-p', `file-exists-p', `file-local-copy', `file-modes', `file-name-all-completions', `file-name-as-directory', `file-name-completion', `file-name-directory', `file-name-nondirectory', `file-name-sans-versions', `file-newer-than-file-p', `file-ownership-preserved-p', `file-readable-p', `file-regular-p', `file-symlink-p', `file-truename', `file-writable-p', `find-backup-file-name', `get-file-buffer', `insert-directory', `insert-file-contents', `load', `make-directory', `make-symbolic-link', `rename-file', `set-file-modes', `set-visited-file-modtime', `shell-command', `unhandled-file-name-directory', `vc-registered', `verify-visited-file-modtime', `write-region'. Handlers for `insert-file-contents' typically need to clear the buffer's modified flag, with `(set-buffer-modified-p nil)', if the VISIT argument is non-`nil'. This also has the effect of unlocking the buffer if it is locked. The handler function must handle all of the above operations, and possibly others to be added in the future. It need not implement all these operations itself--when it has nothing special to do for a certain operation, it can reinvoke the primitive, to handle the operation "in the usual way". It should always reinvoke the primitive for an operation it does not recognize. Here's one way to do this: (defun my-file-handler (operation &rest args) ;; First check for the specific operations ;; that we have special handling for. (cond ((eq operation 'insert-file-contents) ...) ((eq operation 'write-region) ...) ... ;; Handle any operation we don't know about. (t (let ((inhibit-file-name-handlers (cons 'my-file-handler (and (eq inhibit-file-name-operation operation) inhibit-file-name-handlers))) (inhibit-file-name-operation operation)) (apply operation args))))) When a handler function decides to call the ordinary Emacs primitive for the operation at hand, it needs to prevent the primitive from calling the same handler once again, thus leading to an infinite recursion. The example above shows how to do this, with the variables `inhibit-file-name-handlers' and `inhibit-file-name-operation'. Be careful to use them exactly as shown above; the details are crucial for proper behavior in the case of multiple handlers, and for operations that have two file names that may each have handlers. - Variable: inhibit-file-name-handlers This variable holds a list of handlers whose use is presently inhibited for a certain operation. - Variable: inhibit-file-name-operation The operation for which certain handlers are presently inhibited. - Function: find-file-name-handler FILE OPERATION This function returns the handler function for file name FILE, or `nil' if there is none. The argument OPERATION should be the operation to be performed on the file--the value you will pass to the handler as its first argument when you call it. The operation is needed for comparison with `inhibit-file-name-operation'. - Function: file-local-copy FILENAME This function copies file FILENAME to an ordinary non-magic file, if it isn't one already. If FILENAME specifies a magic file name, which programs outside Emacs cannot directly read or write, this copies the contents to an ordinary file and returns that file's name. If FILENAME is an ordinary file name, not magic, then this function does nothing and returns `nil'. - Function: unhandled-file-name-directory FILENAME This function returns the name of a directory that is not magic. It uses the directory part of FILENAME if that is not magic. For a magic file name, it invokes the file name handler, which therefore decides what value to return. This is useful for running a subprocess; every subprocess must have a non-magic directory to serve as its current directory, and this function is a good way to come up with one. File Format Conversion ====================== The variable `format-alist' defines a list of "file formats", which describe textual representations used in files for the data (text, text-properties, and possibly other information) in an Emacs buffer. Emacs performs format conversion if appropriate when reading and writing files. - Variable: format-alist This list contains one format definition for each defined file format. Each format definition is a list of this form: (NAME DOC-STRING REGEXP FROM-FN TO-FN MODIFY MODE-FN) Here is what the elements in a format definition mean: NAME The name of this format. DOC-STRING A documentation string for the format. REGEXP A regular expression which is used to recognize files represented in this format. FROM-FN A shell command or function to decode data in this format (to convert file data into the usual Emacs data representation). A shell command is represented as a string; Emacs runs the command as a filter to perform the conversion. If FROM-FN is a function, it is called with two arguments, BEGIN and END, which specify the part of the buffer it should convert. It should convert the text by editing it in place. Since this can change the length of the text, FROM-FN should return the modified end position. One responsibility of FROM-FN is to make sure that the beginning of the file no longer matches REGEXP. Otherwise it is likely to get called again. TO-FN A shell command or function to encode data in this format--that is, to convert the usual Emacs data representation into this format. If TO-FN is a string, it is a shell command; Emacs runs the command as a filter to perform the conversion. If TO-FN is a function, it is called with two arguments, BEGIN and END, which specify the part of the buffer it should convert. There are two ways it can do the conversion: * By editing the buffer in place. In this case, TO-FN should return the end-position of the range of text, as modified. * By returning a list of annotations. This is a list of elements of the form `(POSITION . STRING)', where POSITION is an integer specifying the relative position in the text to be written, and STRING is the annotation to add there. The list must be sorted in order of position when TO-FN returns it. When `write-region' actually writes the text from the buffer to the file, it intermixes the specified annotations at the corresponding positions. All this takes place without modifying the buffer. MODIFY A flag, `t' if the encoding function modifies the buffer, and `nil' if it works by returning a list of annotations. MODE A mode function to call after visiting a file converted from this format. The function `insert-file-contents' automatically recognizes file formats when it reads the specified file. It checks the text of the beginning of the file against the regular expressions of the format definitions, and if it finds a match, it calls the decoding function for that format. Then it checks all the known formats over again. It keeps checking them until none of them is applicable. Visiting a file, with `find-file-noselect' or the commands that use it, performs conversion likewise (because it calls `insert-file-contents'); it also calls the mode function for each format that it decodes. It stores a list of the format names in the buffer-local variable `buffer-file-format'. - Variable: buffer-file-format This variable states the format of the visited file. More precisely, this is a list of the file format names that were decoded in the course of visiting the current buffer's file. It is always buffer-local in all buffers. When `write-region' writes data into a file, it first calls the encoding functions for the formats listed in `buffer-file-format', in the order of appearance in the list. - Command: format-write-file FILE FORMAT This command writes the current buffer contents into the file FILE in format FORMAT, and makes that format the default for future saves of the buffer. The argument FORMAT is a list of format names. - Command: format-find-file FILE FORMAT This command finds the file FILE, converting it according to format FORMAT. It also makes FORMAT the default if the buffer is saved later. The argument FORMAT is a list of format names. If FORMAT is `nil', no conversion takes place. Interactively, typing just for FORMAT specifies `nil'. - Command: format-insert-file FILE FORMAT &optional BEG END This command inserts the contents of file FILE, converting it according to format FORMAT. If BEG and END are non-`nil', they specify which part of the file to read, as in `insert-file-contents' (*note Reading from Files::.). The return value is like what `insert-file-contents' returns: a list of the absolute file name and the length of the data inserted (after conversion). The argument FORMAT is a list of format names. If FORMAT is `nil', no conversion takes place. Interactively, typing just for FORMAT specifies `nil'. - Variable: auto-save-file-format This variable specifies the format to use for auto-saving. Its value is a list of format names, just like the value of `buffer-file-format'; however, it is used instead of `buffer-file-format' for writing auto-save files. This variable is always buffer-local in all buffers. Backups and Auto-Saving *********************** Backup files and auto-save files are two methods by which Emacs tries to protect the user from the consequences of crashes or of the user's own errors. Auto-saving preserves the text from earlier in the current editing session; backup files preserve file contents prior to the current session. Backup Files ============ A "backup file" is a copy of the old contents of a file you are editing. Emacs makes a backup file the first time you save a buffer into its visited file. Normally, this means that the backup file contains the contents of the file as it was before the current editing session. The contents of the backup file normally remain unchanged once it exists. Backups are usually made by renaming the visited file to a new name. Optionally, you can specify that backup files should be made by copying the visited file. This choice makes a difference for files with multiple names; it also can affect whether the edited file remains owned by the original owner or becomes owned by the user editing it. By default, Emacs makes a single backup file for each file edited. You can alternatively request numbered backups; then each new backup file gets a new name. You can delete old numbered backups when you don't want them any more, or Emacs can delete them automatically. Making Backup Files ------------------- - Function: backup-buffer This function makes a backup of the file visited by the current buffer, if appropriate. It is called by `save-buffer' before saving the buffer the first time. - Variable: buffer-backed-up This buffer-local variable indicates whether this buffer's file has been backed up on account of this buffer. If it is non-`nil', then the backup file has been written. Otherwise, the file should be backed up when it is next saved (if backups are enabled). This is a permanent local; `kill-local-variables' does not alter it. - User Option: make-backup-files This variable determines whether or not to make backup files. If it is non-`nil', then Emacs creates a backup of each file when it is saved for the first time--provided that `backup-inhibited' is `nil' (see below). The following example shows how to change the `make-backup-files' variable only in the Rmail buffers and not elsewhere. Setting it `nil' stops Emacs from making backups of these files, which may save disk space. (You would put this code in your `.emacs' file.) (add-hook 'rmail-mode-hook (function (lambda () (make-local-variable 'make-backup-files) (setq make-backup-files nil)))) - Variable: backup-enable-predicate This variable's value is a function to be called on certain occasions to decide whether a file should have backup files. The function receives one argument, a file name to consider. If the function returns `nil', backups are disabled for that file. Otherwise, the other variables in this section say whether and how to make backups. The default value is this: (lambda (name) (or (< (length name) 5) (not (string-equal "/tmp/" (substring name 0 5))))) - Variable: backup-inhibited If this variable is non-`nil', backups are inhibited. It records the result of testing `backup-enable-predicate' on the visited file name. It can also coherently be used by other mechanisms that inhibit backups based on which file is visited. For example, VC sets this variable non-`nil' to prevent making backups for files managed with a version control system. This is a permanent local, so that changing the major mode does not lose its value. Major modes should not set this variable--they should set `make-backup-files' instead. Backup by Renaming or by Copying? --------------------------------- There are two ways that Emacs can make a backup file: * Emacs can rename the original file so that it becomes a backup file, and then write the buffer being saved into a new file. After this procedure, any other names (i.e., hard links) of the original file now refer to the backup file. The new file is owned by the user doing the editing, and its group is the default for new files written by the user in that directory. * Emacs can copy the original file into a backup file, and then overwrite the original file with new contents. After this procedure, any other names (i.e., hard links) of the original file continue to refer to the current (updated) version of the file. The file's owner and group will be unchanged. The first method, renaming, is the default. The variable `backup-by-copying', if non-`nil', says to use the second method, which is to copy the original file and overwrite it with the new buffer contents. The variable `file-precious-flag', if non-`nil', also has this effect (as a sideline of its main significance). *Note Saving Buffers::. - Variable: backup-by-copying If this variable is non-`nil', Emacs always makes backup files by copying. The following two variables, when non-`nil', cause the second method to be used in certain special cases. They have no effect on the treatment of files that don't fall into the special cases. - Variable: backup-by-copying-when-linked If this variable is non-`nil', Emacs makes backups by copying for files with multiple names (hard links). This variable is significant only if `backup-by-copying' is `nil', since copying is always used when that variable is non-`nil'. - Variable: backup-by-copying-when-mismatch If this variable is non-`nil', Emacs makes backups by copying in cases where renaming would change either the owner or the group of the file. The value has no effect when renaming would not alter the owner or group of the file; that is, for files which are owned by the user and whose group matches the default for a new file created there by the user. This variable is significant only if `backup-by-copying' is `nil', since copying is always used when that variable is non-`nil'. Making and Deleting Numbered Backup Files ----------------------------------------- If a file's name is `foo', the names of its numbered backup versions are `foo.~V~', for various integers V, like this: `foo.~1~', `foo.~2~', `foo.~3~', ..., `foo.~259~', and so on. - User Option: version-control This variable controls whether to make a single non-numbered backup file or multiple numbered backups. `nil' Make numbered backups if the visited file already has numbered backups; otherwise, do not. `never' Do not make numbered backups. ANYTHING ELSE Make numbered backups. The use of numbered backups ultimately leads to a large number of backup versions, which must then be deleted. Emacs can do this automatically or it can ask the user whether to delete them. - User Option: kept-new-versions The value of this variable is the number of newest versions to keep when a new numbered backup is made. The newly made backup is included in the count. The default value is 2. - User Option: kept-old-versions The value of this variable is the number of oldest versions to keep when a new numbered backup is made. The default value is 2. If there are backups numbered 1, 2, 3, 5, and 7, and both of these variables have the value 2, then the backups numbered 1 and 2 are kept as old versions and those numbered 5 and 7 are kept as new versions; backup version 3 is excess. The function `find-backup-file-name' (*note Backup Names::.) is responsible for determining which backup versions to delete, but does not delete them itself. - User Option: delete-old-versions If this variable is non-`nil', then saving a file deletes excess backup versions silently. Otherwise, it asks the user whether to delete them. - User Option: dired-kept-versions This variable specifies how many of the newest backup versions to keep in the Dired command `.' (`dired-clean-directory'). That's the same thing `kept-new-versions' specifies when you make a new backup file. The default value is 2. Naming Backup Files ------------------- The functions in this section are documented mainly because you can customize the naming conventions for backup files by redefining them. If you change one, you probably need to change the rest. - Function: backup-file-name-p FILENAME This function returns a non-`nil' value if FILENAME is a possible name for a backup file. A file with the name FILENAME need not exist; the function just checks the name. (backup-file-name-p "foo") => nil (backup-file-name-p "foo~") => 3 The standard definition of this function is as follows: (defun backup-file-name-p (file) "Return non-nil if FILE is a backup file \ name (numeric or not)..." (string-match "~$" file)) Thus, the function returns a non-`nil' value if the file name ends with a `~'. (We use a backslash to split the documentation string's first line into two lines in the text, but produce just one line in the string itself.) This simple expression is placed in a separate function to make it easy to redefine for customization. - Function: make-backup-file-name FILENAME This function returns a string that is the name to use for a non-numbered backup file for file FILENAME. On Unix, this is just FILENAME with a tilde appended. The standard definition of this function, on most operating systems, is as follows: (defun make-backup-file-name (file) "Create the non-numeric backup file name for FILE...." (concat file "~")) You can change the backup-file naming convention by redefining this function. The following example redefines `make-backup-file-name' to prepend a `.' in addition to appending a tilde: (defun make-backup-file-name (filename) (expand-file-name (concat "." (file-name-nondirectory filename) "~") (file-name-directory filename))) (make-backup-file-name "backups.texi") => ".backups.texi~" Some parts of Emacs, including some Dired commands, assume that backup file names end with `~'. If you do not follow that convention, it will not cause serious problems, but these commands may give less-than-desirable results. - Function: find-backup-file-name FILENAME This function computes the file name for a new backup file for FILENAME. It may also propose certain existing backup files for deletion. `find-backup-file-name' returns a list whose CAR is the name for the new backup file and whose CDR is a list of backup files whose deletion is proposed. Two variables, `kept-old-versions' and `kept-new-versions', determine which backup versions should be kept. This function keeps those versions by excluding them from the CDR of the value. *Note Numbered Backups::. In this example, the value says that `~rms/foo.~5~' is the name to use for the new backup file, and `~rms/foo.~3~' is an "excess" version that the caller should consider deleting now. (find-backup-file-name "~rms/foo") => ("~rms/foo.~5~" "~rms/foo.~3~") - Function: file-newest-backup FILENAME This function returns the name of the most recent backup file for FILENAME, or `nil' if that file has no backup files. Some file comparison commands use this function so that they can automatically compare a file with its most recent backup. Auto-Saving =========== Emacs periodically saves all files that you are visiting; this is called "auto-saving". Auto-saving prevents you from losing more than a limited amount of work if the system crashes. By default, auto-saves happen every 300 keystrokes, or after around 30 seconds of idle time. *Note Auto-Save: (emacs)Auto-Save, for information on auto-save for users. Here we describe the functions used to implement auto-saving and the variables that control them. - Variable: buffer-auto-save-file-name This buffer-local variable is the name of the file used for auto-saving the current buffer. It is `nil' if the buffer should not be auto-saved. buffer-auto-save-file-name => "/xcssun/users/rms/lewis/#files.texi#" - Command: auto-save-mode ARG When used interactively without an argument, this command is a toggle switch: it turns on auto-saving of the current buffer if it is off, and vice-versa. With an argument ARG, the command turns auto-saving on if the value of ARG is `t', a nonempty list, or a positive integer. Otherwise, it turns auto-saving off. - Function: auto-save-file-name-p FILENAME This function returns a non-`nil' value if FILENAME is a string that could be the name of an auto-save file. It works based on knowledge of the naming convention for auto-save files: a name that begins and ends with hash marks (`#') is a possible auto-save file name. The argument FILENAME should not contain a directory part. (make-auto-save-file-name) => "/xcssun/users/rms/lewis/#files.texi#" (auto-save-file-name-p "#files.texi#") => 0 (auto-save-file-name-p "files.texi") => nil The standard definition of this function is as follows: (defun auto-save-file-name-p (filename) "Return non-nil if FILENAME can be yielded by..." (string-match "^#.*#$" filename)) This function exists so that you can customize it if you wish to change the naming convention for auto-save files. If you redefine it, be sure to redefine the function `make-auto-save-file-name' correspondingly. - Function: make-auto-save-file-name This function returns the file name to use for auto-saving the current buffer. This is just the file name with hash marks (`#') appended and prepended to it. This function does not look at the variable `auto-save-visited-file-name' (described below); you should check that before calling this function. (make-auto-save-file-name) => "/xcssun/users/rms/lewis/#backup.texi#" The standard definition of this function is as follows: (defun make-auto-save-file-name () "Return file name to use for auto-saves \ of current buffer...." (if buffer-file-name (concat (file-name-directory buffer-file-name) "#" (file-name-nondirectory buffer-file-name) "#") (expand-file-name (concat "#%" (buffer-name) "#")))) This exists as a separate function so that you can redefine it to customize the naming convention for auto-save files. Be sure to change `auto-save-file-name-p' in a corresponding way. - Variable: auto-save-visited-file-name If this variable is non-`nil', Emacs auto-saves buffers in the files they are visiting. That is, the auto-save is done in the same file that you are editing. Normally, this variable is `nil', so auto-save files have distinct names that are created by `make-auto-save-file-name'. When you change the value of this variable, the value does not take effect until the next time auto-save mode is reenabled in any given buffer. If auto-save mode is already enabled, auto-saves continue to go in the same file name until `auto-save-mode' is called again. - Function: recent-auto-save-p This function returns `t' if the current buffer has been auto-saved since the last time it was read in or saved. - Function: set-buffer-auto-saved This function marks the current buffer as auto-saved. The buffer will not be auto-saved again until the buffer text is changed again. The function returns `nil'. - User Option: auto-save-interval The value of this variable is the number of characters that Emacs reads from the keyboard between auto-saves. Each time this many more characters are read, auto-saving is done for all buffers in which it is enabled. - User Option: auto-save-timeout The value of this variable is the number of seconds of idle time that should cause auto-saving. Each time the user pauses for this long, Emacs auto-saves any buffers that need it. (Actually, the specified timeout is multiplied by a factor depending on the size of the current buffer.) - Variable: auto-save-hook This normal hook is run whenever an auto-save is about to happen. - User Option: auto-save-default If this variable is non-`nil', buffers that are visiting files have auto-saving enabled by default. Otherwise, they do not. - Command: do-auto-save &optional NO-MESSAGE CURRENT-ONLY This function auto-saves all buffers that need to be auto-saved. It saves all buffers for which auto-saving is enabled and that have been changed since the previous auto-save. Normally, if any buffers are auto-saved, a message that says `Auto-saving...' is displayed in the echo area while auto-saving is going on. However, if NO-MESSAGE is non-`nil', the message is inhibited. If CURRENT-ONLY is non-`nil', only the current buffer is auto-saved. - Function: delete-auto-save-file-if-necessary This function deletes the current buffer's auto-save file if `delete-auto-save-files' is non-`nil'. It is called every time a buffer is saved. - Variable: delete-auto-save-files This variable is used by the function `delete-auto-save-file-if-necessary'. If it is non-`nil', Emacs deletes auto-save files when a true save is done (in the visited file). This saves disk space and unclutters your directory. - Function: rename-auto-save-file This function adjusts the current buffer's auto-save file name if the visited file name has changed. It also renames an existing auto-save file. If the visited file name has not changed, this function does nothing. - Variable: buffer-saved-size The value of this buffer-local variable is the length of the current buffer as of the last time it was read in, saved, or auto-saved. This is used to detect a substantial decrease in size, and turn off auto-saving in response. If it is -1, that means auto-saving is temporarily shut off in this buffer due to a substantial deletion. Explicitly saving the buffer stores a positive value in this variable, thus reenabling auto-saving. Turning auto-save mode off or on also alters this variable. - Variable: auto-save-list-file-name This variable (if non-`nil') specifies a file for recording the names of all the auto-save files. Each time Emacs does auto-saving, it writes two lines into this file for each buffer that has auto-saving enabled. The first line gives the name of the visited file (it's empty if the buffer has none), and the second gives the name of the auto-save file. If Emacs exits normally, it deletes this file. If Emacs crashes, you can look in the file to find all the auto-save files that might contain work that was otherwise lost. The `recover-session' command uses these files. The default name for this file is in your home directory and starts with `.saves-'. It also contains the Emacs process ID and the host name. Reverting ========= If you have made extensive changes to a file and then change your mind about them, you can get rid of them by reading in the previous version of the file with the `revert-buffer' command. *Note Reverting a Buffer: (emacs)Reverting. - Command: revert-buffer &optional IGNORE-AUTO NOCONFIRM This command replaces the buffer text with the text of the visited file on disk. This action undoes all changes since the file was visited or saved. By default, if the latest auto-save file is more recent than the visited file, `revert-buffer' asks the user whether to use that instead. But if the argument IGNORE-AUTO is non-`nil', then only the the visited file itself is used. Interactively, IGNORE-AUTO is `t' unless there is a numeric prefix argument; thus, the interactive default is to check the auto-save file. Normally, `revert-buffer' asks for confirmation before it changes the buffer; but if the argument NOCONFIRM is non-`nil', `revert-buffer' does not ask for confirmation. Reverting tries to preserve marker positions in the buffer by using the replacement feature of `insert-file-contents'. If the buffer contents and the file contents are identical before the revert operation, reverting preserves all the markers. If they are not identical, reverting does change the buffer; then it preserves the markers in the unchanged text (if any) at the beginning and end of the buffer. Preserving any additional markers would be problematical. You can customize how `revert-buffer' does its work by setting these variables--typically, as buffer-local variables. - Variable: revert-without-query This variable holds a list of files that should be reverted without query. The value is a list of regular expressions. If a file name matches one of these regular expressions, then `revert-buffer' reverts the file without asking the user for confirmation, if the file has changed on disk and the buffer is not modified. - Variable: revert-buffer-function The value of this variable is the function to use to revert this buffer. If non-`nil', it is called as a function with no arguments to do the work of reverting. If the value is `nil', reverting works the usual way. Modes such as Dired mode, in which the text being edited does not consist of a file's contents but can be regenerated in some other fashion, give this variable a buffer-local value that is a function to regenerate the contents. - Variable: revert-buffer-insert-file-contents-function The value of this variable, if non-`nil', is the function to use to insert the updated contents when reverting this buffer. The function receives two arguments: first the file name to use; second, `t' if the user has asked to read the auto-save file. - Variable: before-revert-hook This normal hook is run by `revert-buffer' before actually inserting the modified contents--but only if `revert-buffer-function' is `nil'. Font Lock mode uses this hook to record that the buffer contents are no longer fontified. - Variable: after-revert-hook This normal hook is run by `revert-buffer' after actually inserting the modified contents--but only if `revert-buffer-function' is `nil'. Font Lock mode uses this hook to recompute the fonts for the updated buffer contents. Buffers ******* A "buffer" is a Lisp object containing text to be edited. Buffers are used to hold the contents of files that are being visited; there may also be buffers that are not visiting files. While several buffers may exist at one time, exactly one buffer is designated the "current buffer" at any time. Most editing commands act on the contents of the current buffer. Each buffer, including the current buffer, may or may not be displayed in any windows. Buffer Basics ============= A "buffer" is a Lisp object containing text to be edited. Buffers are used to hold the contents of files that are being visited; there may also be buffers that are not visiting files. While several buffers may exist at one time, exactly one buffer is designated the "current buffer" at any time. Most editing commands act on the contents of the current buffer. Each buffer, including the current buffer, may or may not be displayed in any windows. Buffers in Emacs editing are objects that have distinct names and hold text that can be edited. Buffers appear to Lisp programs as a special data type. You can think of the contents of a buffer as a string that you can extend; insertions and deletions may occur in any part of the buffer. *Note Text::. A Lisp buffer object contains numerous pieces of information. Some of this information is directly accessible to the programmer through variables, while other information is accessible only through special-purpose functions. For example, the visited file name is directly accessible through a variable, while the value of point is accessible only through a primitive function. Buffer-specific information that is directly accessible is stored in "buffer-local" variable bindings, which are variable values that are effective only in a particular buffer. This feature allows each buffer to override the values of certain variables. Most major modes override variables such as `fill-column' or `comment-column' in this way. For more information about buffer-local variables and functions related to them, see *Note Buffer-Local Variables::. For functions and variables related to visiting files in buffers, see *Note Visiting Files:: and *Note Saving Buffers::. For functions and variables related to the display of buffers in windows, see *Note Buffers and Windows::. - Function: bufferp OBJECT This function returns `t' if OBJECT is a buffer, `nil' otherwise. The Current Buffer ================== There are, in general, many buffers in an Emacs session. At any time, one of them is designated as the "current buffer". This is the buffer in which most editing takes place, because most of the primitives for examining or changing text in a buffer operate implicitly on the current buffer (*note Text::.). Normally the buffer that is displayed on the screen in the selected window is the current buffer, but this is not always so: a Lisp program can temporarily designate any buffer as current in order to operate on its contents, without changing what is displayed on the screen. The way to designate a current buffer in a Lisp program is by calling `set-buffer'. The specified buffer remains current until a new one is designated. When an editing command returns to the editor command loop, the command loop designates the buffer displayed in the selected window as current, to prevent confusion: the buffer that the cursor is in when Emacs reads a command is the buffer that the command will apply to. (*Note Command Loop::.) Therefore, `set-buffer' is not the way to switch visibly to a different buffer so that the user can edit it. For this, you must use the functions described in *Note Displaying Buffers::. However, Lisp functions that change to a different current buffer should not depend on the command loop to set it back afterwards. Editing commands written in Emacs Lisp can be called from other programs as well as from the command loop. It is convenient for the caller if the subroutine does not change which buffer is current (unless, of course, that is the subroutine's purpose). Therefore, you should normally use `set-buffer' within a `save-current-buffer' or `save-excursion' (*note Excursions::.) form that will restore the current buffer when your function is done. Here is an example, the code for the command `append-to-buffer' (with the documentation string abridged): (defun append-to-buffer (buffer start end) "Append to specified buffer the text of the region. ..." (interactive "BAppend to buffer: \nr") (let ((oldbuf (current-buffer))) (save-current-buffer (set-buffer (get-buffer-create buffer)) (insert-buffer-substring oldbuf start end)))) This function binds a local variable to record the current buffer, and then `save-current-buffer' arranges to make it current again. Next, `set-buffer' makes the specified buffer current. Finally, `insert-buffer-substring' copies the string from the original current buffer to the specified (and now current) buffer. If the buffer appended to happens to be displayed in some window, the next redisplay will show how its text has changed. Otherwise, you will not see the change immediately on the screen. The buffer becomes current temporarily during the execution of the command, but this does not cause it to be displayed. If you make local bindings (with `let' or function arguments) for a variable that may also have buffer-local bindings, make sure that the same buffer is current at the beginning and at the end of the local binding's scope. Otherwise you might bind it in one buffer and unbind it in another! There are two ways to do this. In simple cases, you may see that nothing ever changes the current buffer within the scope of the binding. Otherwise, use `save-current-buffer' or `save-excursion' to make sure that the buffer current at the beginning is current again whenever the variable is unbound. It is not reliable to change the current buffer back with `set-buffer', because that won't do the job if a quit happens while the wrong buffer is current. Here is what *not* to do: (let (buffer-read-only (obuf (current-buffer))) (set-buffer ...) ... (set-buffer obuf)) Using `save-current-buffer', as shown here, handles quitting, errors, and `throw', as well as ordinary evaluation. (let (buffer-read-only) (save-current-buffer (set-buffer ...) ...)) - Function: current-buffer This function returns the current buffer. (current-buffer) => # - Function: set-buffer BUFFER-OR-NAME This function makes BUFFER-OR-NAME the current buffer. It does not display the buffer in the currently selected window or in any other window, so the user cannot necessarily see the buffer. But Lisp programs can in any case work on it. This function returns the buffer identified by BUFFER-OR-NAME. An error is signaled if BUFFER-OR-NAME does not identify an existing buffer. - Special Form: save-current-buffer BODY... The `save-current-buffer' macro saves the identity of the current buffer, evaluates the BODY forms, and finally restores that buffer as current. The return value is the value of the last form in BODY. The current buffer is restored even in case of an abnormal exit via `throw' or error (*note Nonlocal Exits::.). If the buffer that used to be current has been killed by the time of exit from `save-current-buffer', then it is not made current again, of course. Instead, whichever buffer was current just before exit remains current. - Macro: with-current-buffer BUFFER BODY... The `with-current-buffer' macro saves the identity of the current buffer, makes BUFFER current, evaluates the BODY forms, and finally restores the buffer. The return value is the value of the last form in BODY. The current buffer is restored even in case of an abnormal exit via `throw' or error (*note Nonlocal Exits::.). - Macro: with-temp-buffer BODY... The `with-temp-buffer' macro evaluates the BODY forms with a temporary buffer as the current buffer. It saves the identity of the current buffer, creates a temporary buffer and makes it current, evaluates the BODY forms, and finally restores the previous current buffer while killing the temporary buffer. The return value is the value of the last form in BODY. You can return the contents of the temporary buffer by using `(buffer-string)' as the last form. The current buffer is restored even in case of an abnormal exit via `throw' or error (*note Nonlocal Exits::.). See also `with-temp-file' in *Note Writing to Files::. Buffer Names ============ Each buffer has a unique name, which is a string. Many of the functions that work on buffers accept either a buffer or a buffer name as an argument. Any argument called BUFFER-OR-NAME is of this sort, and an error is signaled if it is neither a string nor a buffer. Any argument called BUFFER must be an actual buffer object, not a name. Buffers that are ephemeral and generally uninteresting to the user have names starting with a space, so that the `list-buffers' and `buffer-menu' commands don't mention them. A name starting with space also initially disables recording undo information; see *Note Undo::. - Function: buffer-name &optional BUFFER This function returns the name of BUFFER as a string. If BUFFER is not supplied, it defaults to the current buffer. If `buffer-name' returns `nil', it means that BUFFER has been killed. *Note Killing Buffers::. (buffer-name) => "buffers.texi" (setq foo (get-buffer "temp")) => # (kill-buffer foo) => nil (buffer-name foo) => nil foo => # - Command: rename-buffer NEWNAME &optional UNIQUE This function renames the current buffer to NEWNAME. An error is signaled if NEWNAME is not a string, or if there is already a buffer with that name. The function returns NEWNAME. Ordinarily, `rename-buffer' signals an error if NEWNAME is already in use. However, if UNIQUE is non-`nil', it modifies NEWNAME to make a name that is not in use. Interactively, you can make UNIQUE non-`nil' with a numeric prefix argument. One application of this command is to rename the `*shell*' buffer to some other name, thus making it possible to create a second shell buffer under the name `*shell*'. - Function: get-buffer BUFFER-OR-NAME This function returns the buffer specified by BUFFER-OR-NAME. If BUFFER-OR-NAME is a string and there is no buffer with that name, the value is `nil'. If BUFFER-OR-NAME is a buffer, it is returned as given. (That is not very useful, so the argument is usually a name.) For example: (setq b (get-buffer "lewis")) => # (get-buffer b) => # (get-buffer "Frazzle-nots") => nil See also the function `get-buffer-create' in *Note Creating Buffers::. - Function: generate-new-buffer-name STARTING-NAME This function returns a name that would be unique for a new buffer--but does not create the buffer. It starts with STARTING-NAME, and produces a name not currently in use for any buffer by appending a number inside of `<...>'. See the related function `generate-new-buffer' in *Note Creating Buffers::. Buffer File Name ================ The "buffer file name" is the name of the file that is visited in that buffer. When a buffer is not visiting a file, its buffer file name is `nil'. Most of the time, the buffer name is the same as the nondirectory part of the buffer file name, but the buffer file name and the buffer name are distinct and can be set independently. *Note Visiting Files::. - Function: buffer-file-name &optional BUFFER This function returns the absolute file name of the file that BUFFER is visiting. If BUFFER is not visiting any file, `buffer-file-name' returns `nil'. If BUFFER is not supplied, it defaults to the current buffer. (buffer-file-name (other-buffer)) => "/usr/user/lewis/manual/files.texi" - Variable: buffer-file-name This buffer-local variable contains the name of the file being visited in the current buffer, or `nil' if it is not visiting a file. It is a permanent local, unaffected by `kill-local-variables'. buffer-file-name => "/usr/user/lewis/manual/buffers.texi" It is risky to change this variable's value without doing various other things. Normally it is better to use `set-visited-file-name' (see below); some of the things done there, such as changing the buffer name, are not strictly necessary, but others are essential to avoid confusing Emacs. - Variable: buffer-file-truename This buffer-local variable holds the truename of the file visited in the current buffer, or `nil' if no file is visited. It is a permanent local, unaffected by `kill-local-variables'. *Note Truenames::. - Variable: buffer-file-number This buffer-local variable holds the file number and directory device number of the file visited in the current buffer, or `nil' if no file or a nonexistent file is visited. It is a permanent local, unaffected by `kill-local-variables'. The value is normally a list of the form `(FILENUM DEVNUM)'. This pair of numbers uniquely identifies the file among all files accessible on the system. See the function `file-attributes', in *Note File Attributes::, for more information about them. - Function: get-file-buffer FILENAME This function returns the buffer visiting file FILENAME. If there is no such buffer, it returns `nil'. The argument FILENAME, which must be a string, is expanded (*note File Name Expansion::.), then compared against the visited file names of all live buffers. (get-file-buffer "buffers.texi") => # In unusual circumstances, there can be more than one buffer visiting the same file name. In such cases, this function returns the first such buffer in the buffer list. - Command: set-visited-file-name FILENAME &optional NO-QUERY ALONG-WITH-FILE If FILENAME is a non-empty string, this function changes the name of the file visited in current buffer to FILENAME. (If the buffer had no visited file, this gives it one.) The *next time* the buffer is saved it will go in the newly-specified file. This command marks the buffer as modified, since it does not (as far as Emacs knows) match the contents of FILENAME, even if it matched the former visited file. If FILENAME is `nil' or the empty string, that stands for "no visited file". In this case, `set-visited-file-name' marks the buffer as having no visited file. Normally, this function asks the user for confirmation if the specified file already exists. If NO-QUERY is non-`nil', that prevents asking this question. If ALONG-WITH-FILE is non-`nil', that means to assume that the former visited file has been renamed to FILENAME. When the function `set-visited-file-name' is called interactively, it prompts for FILENAME in the minibuffer. - Variable: list-buffers-directory This buffer-local variable specifies a string to display in a buffer listing where the visited file name would go, for buffers that don't have a visited file name. Dired buffers use this variable. Buffer Modification =================== Emacs keeps a flag called the "modified flag" for each buffer, to record whether you have changed the text of the buffer. This flag is set to `t' whenever you alter the contents of the buffer, and cleared to `nil' when you save it. Thus, the flag shows whether there are unsaved changes. The flag value is normally shown in the mode line (*note Mode Line Variables::.), and controls saving (*note Saving Buffers::.) and auto-saving (*note Auto-Saving::.). Some Lisp programs set the flag explicitly. For example, the function `set-visited-file-name' sets the flag to `t', because the text does not match the newly-visited file, even if it is unchanged from the file formerly visited. The functions that modify the contents of buffers are described in *Note Text::. - Function: buffer-modified-p &optional BUFFER This function returns `t' if the buffer BUFFER has been modified since it was last read in from a file or saved, or `nil' otherwise. If BUFFER is not supplied, the current buffer is tested. - Function: set-buffer-modified-p FLAG This function marks the current buffer as modified if FLAG is non-`nil', or as unmodified if the flag is `nil'. Another effect of calling this function is to cause unconditional redisplay of the mode line for the current buffer. In fact, the function `force-mode-line-update' works by doing this: (set-buffer-modified-p (buffer-modified-p)) - Command: not-modified This command marks the current buffer as unmodified, and not needing to be saved. With prefix arg, it marks the buffer as modified, so that it will be saved at the next suitable occasion. Don't use this function in programs, since it prints a message in the echo area; use `set-buffer-modified-p' (above) instead. - Function: buffer-modified-tick &optional BUFFER This function returns BUFFER's modification-count. This is a counter that increments every time the buffer is modified. If BUFFER is `nil' (or omitted), the current buffer is used. Comparison of Modification Time =============================== Suppose that you visit a file and make changes in its buffer, and meanwhile the file itself is changed on disk. At this point, saving the buffer would overwrite the changes in the file. Occasionally this may be what you want, but usually it would lose valuable information. Emacs therefore checks the file's modification time using the functions described below before saving the file. - Function: verify-visited-file-modtime BUFFER This function compares what BUFFER has recorded for the modification time of its visited file against the actual modification time of the file as recorded by the operating system. The two should be the same unless some other process has written the file since Emacs visited or saved it. The function returns `t' if the last actual modification time and Emacs's recorded modification time are the same, `nil' otherwise. - Function: clear-visited-file-modtime This function clears out the record of the last modification time of the file being visited by the current buffer. As a result, the next attempt to save this buffer will not complain of a discrepancy in file modification times. This function is called in `set-visited-file-name' and other exceptional places where the usual test to avoid overwriting a changed file should not be done. - Function: visited-file-modtime This function returns the buffer's recorded last file modification time, as a list of the form `(HIGH . LOW)'. (This is the same format that `file-attributes' uses to return time values; see *Note File Attributes::.) - Function: set-visited-file-modtime &optional TIME This function updates the buffer's record of the last modification time of the visited file, to the value specified by TIME if TIME is not `nil', and otherwise to the last modification time of the visited file. If TIME is not `nil', it should have the form `(HIGH . LOW)' or `(HIGH LOW)', in either case containing two integers, each of which holds 16 bits of the time. This function is useful if the buffer was not read from the file normally, or if the file itself has been changed for some known benign reason. - Function: ask-user-about-supersession-threat FILENAME This function is used to ask a user how to proceed after an attempt to modify an obsolete buffer visiting file FILENAME. An "obsolete buffer" is an unmodified buffer for which the associated file on disk is newer than the last save-time of the buffer. This means some other program has probably altered the file. Depending on the user's answer, the function may return normally, in which case the modification of the buffer proceeds, or it may signal a `file-supersession' error with data `(FILENAME)', in which case the proposed buffer modification is not allowed. This function is called automatically by Emacs on the proper occasions. It exists so you can customize Emacs by redefining it. See the file `userlock.el' for the standard definition. See also the file locking mechanism in *Note File Locks::. Read-Only Buffers ================= If a buffer is "read-only", then you cannot change its contents, although you may change your view of the contents by scrolling and narrowing. Read-only buffers are used in two kinds of situations: * A buffer visiting a write-protected file is normally read-only. Here, the purpose is to inform the user th