@c -*-texinfo-*-@c This is part of the GNU Emacs Lisp Reference Manual.@c Copyright (C) 1990, 1991, 1992, 1993, 1995, 1998 Free Software Foundation, Inc. @c See the file elisp.texi for copying conditions.@setfilename ../info/tips@node Tips, GNU Emacs Internals, System Interface, Top@appendix Tips and Conventions@cindex tips@cindex standards of coding style@cindex coding standards This chapter describes no additional features of Emacs Lisp. Insteadit gives advice on making effective use of the features described in theprevious chapters, and describes conventions Emacs Lisp programmersshould follow.@menu* Coding Conventions:: Conventions for clean and robust programs.* Compilation Tips:: Making compiled code run fast.* Documentation Tips:: Writing readable documentation strings.* Comment Tips:: Conventions for writing comments.* Library Headers:: Standard headers for library packages.@end menu@node Coding Conventions@section Emacs Lisp Coding Conventions Here are conventions that you should follow when writing Emacs Lispcode intended for widespread use:@itemize @bullet@itemSince all global variables share the same name space, and all functionsshare another name space, you should choose a short word to distinguishyour program from other Lisp programs. Then take care to begin thenames of all global variables, constants, and functions with the chosenprefix. This helps avoid name conflicts.This recommendation applies even to names for traditional Lispprimitives that are not primitives in Emacs Lisp---even to@code{copy-list}. Believe it or not, there is more than one plausibleway to define @code{copy-list}. Play it safe; append your name prefixto produce a name like @code{foo-copy-list} or @code{mylib-copy-list}instead.If you write a function that you think ought to be added to Emacs undera certain name, such as @code{twiddle-files}, don't call it by that namein your program. Call it @code{mylib-twiddle-files} in your program,and send mail to @samp{bug-gnu-emacs@@gnu.org} suggesting we addit to Emacs. If and when we do, we can change the name easily enough.If one prefix is insufficient, your package may use two or threealternative common prefixes, so long as they make sense.Separate the prefix from the rest of the symbol name with a hyphen,@samp{-}. This will be consistent with Emacs itself and with most EmacsLisp programs.@itemIt is often useful to put a call to @code{provide} in each separatelibrary program, at least if there is more than one entry point to theprogram.@itemIf a file requires certain other library programs to be loadedbeforehand, then the comments at the beginning of the file should sayso. Also, use @code{require} to make sure they are loaded.@itemIf one file @var{foo} uses a macro defined in another file @var{bar},@var{foo} should contain this expression before the first use of themacro:@example(eval-when-compile (require '@var{bar}))@end example@noindent(And the library @var{bar} should contain @code{(provide '@var{bar})},to make the @code{require} work.) This will cause @var{bar} to beloaded when you byte-compile @var{foo}. Otherwise, you risk compiling@var{foo} without the necessary macro loaded, and that would producecompiled code that won't work right. @xref{Compiling Macros}.Using @code{eval-when-compile} avoids loading @var{bar} whenthe compiled version of @var{foo} is @emph{used}.@itemWhen defining a major mode, please follow the major modeconventions. @xref{Major Mode Conventions}.@itemWhen defining a minor mode, please follow the minor modeconventions. @xref{Minor Mode Conventions}.@itemIf the purpose of a function is to tell you whether a certain conditionis true or false, give the function a name that ends in @samp{p}. Ifthe name is one word, add just @samp{p}; if the name is multiple words,add @samp{-p}. Examples are @code{framep} and @code{frame-live-p}.@itemIf a user option variable records a true-or-false condition, give it aname that ends in @samp{-flag}.@item@cindex reserved keys@cindex keys, reservedPlease do not define @kbd{C-c @var{letter}} as a key in your majormodes. These sequences are reserved for users; they are the@strong{only} sequences reserved for users, so do not block them.Instead, define sequences consisting of @kbd{C-c} followed by a controlcharacter, a digit, or certain punctuation characters. These sequencesare reserved for major modes.Changing all the Emacs major modes to follow this convention was a lotof work. Abandoning this convention would make that work go to waste,and inconvenience users.@itemSequences consisting of @kbd{C-c} followed by @kbd{@{}, @kbd{@}},@kbd{<}, @kbd{>}, @kbd{:} or @kbd{;} are also reserved for major modes.@itemSequences consisting of @kbd{C-c} followed by any other punctuationcharacter are allocated for minor modes. Using them in a major mode isnot absolutely prohibited, but if you do that, the major mode bindingmay be shadowed from time to time by minor modes.@itemFunction keys @key{F5} through @key{F9} without modifier keys arereserved for users to define.@itemDo not bind @kbd{C-h} following any prefix character (including@kbd{C-c}). If you don't bind @kbd{C-h}, it is automatically availableas a help character for listing the subcommands of the prefix character.@itemDo not bind a key sequence ending in @key{ESC} except followinganother @key{ESC}. (That is, it is OK to bind a sequence ending in@kbd{@key{ESC} @key{ESC}}.)The reason for this rule is that a non-prefix binding for @key{ESC} inany context prevents recognition of escape sequences as function keys inthat context.@itemApplications should not bind mouse events based on button 1 with theshift key held down. These events include @kbd{S-mouse-1},@kbd{M-S-mouse-1}, @kbd{C-S-mouse-1}, and so on. They are reserved forusers.@itemSpecial major modes used for read-only text should usually redefine@kbd{mouse-2} and @key{RET} to trace some sort of reference in the text.Modes such as Dired, Info, Compilation, and Occur redefine it in thisway.@itemWhen a package provides a modification of ordinary Emacs behavior, it isgood to include a command to enable and disable the feature, Provide acommand named @code{@var{whatever}-mode} which turns the feature on oroff, and make it autoload (@pxref{Autoload}). Design the package sothat simply loading it has no visible effect---that should not enablethe feature. Users will request the feature by invoking the command.@itemIt is a bad idea to define aliases for the Emacs primitives. Use thestandard names instead.@itemRedefining (or advising) an Emacs primitive is discouraged. It may dothe right thing for a particular program, but there is no telling whatother programs might break as a result.@itemIf a file does replace any of the functions or library programs ofstandard Emacs, prominent comments at the beginning of the file shouldsay which functions are replaced, and how the behavior of thereplacements differs from that of the originals.@itemPlease keep the names of your Emacs Lisp source files to 13 charactersor less. This way, if the files are compiled, the compiled files' nameswill be 14 characters or less, which is short enough to fit on all kindsof Unix systems.@itemDon't use @code{next-line} or @code{previous-line} in programs; nearlyalways, @code{forward-line} is more convenient as well as morepredictable and robust. @xref{Text Lines}.@itemDon't call functions that set the mark, unless setting the mark is oneof the intended features of your program. The mark is a user-levelfeature, so it is incorrect to change the mark except to supply a valuefor the user's benefit. @xref{The Mark}.In particular, don't use any of these functions:@itemize @bullet@item@code{beginning-of-buffer}, @code{end-of-buffer}@item@code{replace-string}, @code{replace-regexp}@end itemizeIf you just want to move point, or replace a certain string, without anyof the other features intended for interactive users, you can replacethese functions with one or two lines of simple Lisp code.@itemUse lists rather than vectors, except when there is a particular reasonto use a vector. Lisp has more facilities for manipulating lists thanfor vectors, and working with lists is usually more convenient.Vectors are advantageous for tables that are substantial in size and areaccessed in random order (not searched front to back), provided there isno need to insert or delete elements (only lists allow that).@itemThe recommended way to print a message in the echo area is withthe @code{message} function, not @code{princ}. @xref{The Echo Area}.@itemWhen you encounter an error condition, call the function @code{error}(or @code{signal}). The function @code{error} does not return.@xref{Signaling Errors}.Do not use @code{message}, @code{throw}, @code{sleep-for},or @code{beep} to report errors.@itemAn error message should start with a capital letter but should not endwith a period.@itemMany commands that take a long time to execute display a message thatsays @samp{Operating...} when they start, and change it to@samp{Operating...done} when they finish. Please keep the style ofthese messages uniform: @emph{no} space around the ellipsis, and@emph{no} period at the end.@itemTry to avoid using recursive edits. Instead, do what the Rmail @kbd{e}command does: use a new local keymap that contains one command definedto switch back to the old local keymap. Or do what the@code{edit-options} command does: switch to another buffer and let theuser switch back at will. @xref{Recursive Editing}.@itemIn some other systems there is a convention of choosing variable namesthat begin and end with @samp{*}. We don't use that convention in EmacsLisp, so please don't use it in your programs. (Emacs uses such namesonly for special-purpose buffers.) The users will find Emacs morecoherent if all libraries use the same conventions.@itemTry to avoid compiler warnings about undefined free variables, by adding@code{defvar} definitions for these variables.If you bind a variable in one function, and use it or set it in anotherfunction, the compiler warns about the latter function unless thevariable has a definition. But often these variables have short names,and it is not clean for Lisp packages to define such variable names.Therefore, you should rename the variable to start with the name prefixused for the other functions and variables in your package.@itemIndent each function with @kbd{C-M-q} (@code{indent-sexp}) using thedefault indentation parameters.@itemDon't make a habit of putting close-parentheses on lines by themselves;Lisp programmers find this disconcerting. Once in a while, when thereis a sequence of many consecutive close-parentheses, it may make senseto split the sequence in one or two significant places.@itemPlease put a copyright notice on the file if you give copies to anyone.Use a message like this one:@smallexample;; Copyright (C) @var{year} @var{name};; 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-1307 USA@end smallexampleIf you have signed papers to assign the copyright to the Foundation,then use @samp{Free Software Foundation, Inc.} as @var{name}.Otherwise, use your name.@end itemize@node Compilation Tips@section Tips for Making Compiled Code Fast@cindex execution speed@cindex speedups Here are ways of improving the execution speed of byte-compiledLisp programs.@itemize @bullet@item@cindex profiling@cindex timing programs@cindex @file{profile.el}@cindex @file{elp.el}Profile your program with the @file{profile} library or the @file{elp}library. See the files @file{profile.el} and @file{elp.el} forinstructions.@itemUse iteration rather than recursion whenever possible.Function calls are slow in Emacs Lisp even when a compiled functionis calling another compiled function.@itemUsing the primitive list-searching functions @code{memq}, @code{member},@code{assq}, or @code{assoc} is even faster than explicit iteration. Itcan be worth rearranging a data structure so that one of these primitivesearch functions can be used.@itemCertain built-in functions are handled specially in byte-compiled code, avoiding the need for an ordinary function call. It is a good idea touse these functions rather than alternatives. To see whether a functionis handled specially by the compiler, examine its @code{byte-compile}property. If the property is non-@code{nil}, then the function ishandled specially.For example, the following input will show you that @code{aref} iscompiled specially (@pxref{Array Functions}):@example@group(get 'aref 'byte-compile) @result{} byte-compile-two-args@end group@end example@itemIf calling a small function accounts for a substantial part of yourprogram's running time, make the function inline. This eliminatesthe function call overhead. Since making a function inline reducesthe flexibility of changing the program, don't do it unless it givesa noticeable speedup in something slow enough that users care aboutthe speed. @xref{Inline Functions}.@end itemize@node Documentation Tips@section Tips for Documentation Strings@tindex checkdoc-minor-mode@findex checkdoc-minor-mode Here are some tips and conventions for the writing of documentationstrings. You can check many of these conventions by running the command@kbd{M-x checkdoc-minor-mode}.@itemize @bullet@itemEvery command, function, or variable intended for users to know aboutshould have a documentation string.@itemAn internal variable or subroutine of a Lisp program might as well havea documentation string. In earlier Emacs versions, you could save spaceby using a comment instead of a documentation string, but that is nolonger the case.@itemThe first line of the documentation string should consist of one or twocomplete sentences that stand on their own as a summary. @kbd{M-xapropos} displays just the first line, and if it doesn't stand on itsown, the result looks bad. In particular, start the first line with acapital letter and end with a period.The documentation string can have additional lines that expand on thedetails of how to use the function or variable. The additional linesshould be made up of complete sentences also, but they may be filled ifthat looks good.@itemFor consistency, phrase the verb in the first sentence of afunction's documentation string as an infinitive with ``to'' omitted. Forinstance, use ``Return the cons of A and B.'' in preference to ``Returnsthe cons of A and B@.'' Usually it looks good to do likewise for therest of the first paragraph. Subsequent paragraphs usually look betterif they have proper subjects.@itemWrite documentation strings in the active voice, not the passive, and inthe present tense, not the future. For instance, use ``Return a listcontaining A and B.'' instead of ``A list containing A and B will bereturned.''@itemAvoid using the word ``cause'' (or its equivalents) unnecessarily.Instead of, ``Cause Emacs to display text in boldface,'' write just``Display text in boldface.''@itemDo not start or end a documentation string with whitespace.@itemFormat the documentation string so that it fits in an Emacs window on an80-column screen. It is a good idea for most lines to be no wider than60 characters. The first line can be wider if necessary to fit the information that ought to be there.However, rather than simply filling the entire documentation string, youcan make it much more readable by choosing line breaks with care.Use blank lines between topics if the documentation string is long.@item@strong{Do not} indent subsequent lines of a documentation string sothat the text is lined up in the source code with the text of the firstline. This looks nice in the source code, but looks bizarre when usersview the documentation. Remember that the indentation before thestarting double-quote is not part of the string!@itemWhen the user tries to use a disabled command, Emacs displays just thefirst paragraph of its documentation string---everything through thefirst blank line. If you wish, you can choose which information toinclude before the first blank line so as to make this display useful.@itemA variable's documentation string should start with @samp{*} if thevariable is one that users would often want to set interactively. Ifthe value is a long list, or a function, or if the variable would be setonly in init files, then don't start the documentation string with@samp{*}. @xref{Defining Variables}.@itemThe documentation string for a variable that is a yes-or-no flag shouldstart with words such as ``Non-nil means@dots{}'', to make it clear thatall non-@code{nil} values are equivalent and indicate explicitly what@code{nil} and non-@code{nil} mean.@itemWhen a function's documentation string mentions the value of an argumentof the function, use the argument name in capital letters as if it werea name for that value. Thus, the documentation string of the function@code{/} refers to its second argument as @samp{DIVISOR}, because theactual argument name is @code{divisor}.Also use all caps for meta-syntactic variables, such as when you showthe decomposition of a list or vector into subunits, some of which mayvary.@item@iftexWhen a documentation string refers to a Lisp symbol, write it as itwould be printed (which usually means in lower case), with single-quotesaround it. For example: @samp{`lambda'}. There are two exceptions:write @code{t} and @code{nil} without single-quotes.@end iftex@ifinfoWhen a documentation string refers to a Lisp symbol, write it as itwould be printed (which usually means in lower case), with single-quotesaround it. For example: @samp{lambda}. There are two exceptions: writet and nil without single-quotes. (In this manual, we use a differentconvention, with single-quotes for all symbols.)@end ifinfoHelp mode automatically creates a hyperlink when a documentation stringuses a symbol name inside single quotes, if the symbol has either afunction or a variable definition. You do not need to do anythingspecial to make use of this feature. However, when a symbol has both afunction definition and a variable definition, and you want to refer tojust one of them, you can specify which one by writing one of the words@samp{variable}, @samp{option}, @samp{function}, or @samp{command},immediately before the symbol name. (Case makes no difference inrecognizing these indicator words.) For example, if you write@exampleThis function sets the variable `buffer-file-name'.@end example@noindentthen the hyperlink will refer only to the variable documentation of@code{buffer-file-name}, and not to its function documentation.If a symbol has a function definition and/or a variable definition, butthose are irrelevant to the use of the symbol that you are documenting,you can write the word @samp{symbol} before the symbol name to preventmaking any hyperlink. For example,@exampleIf the argument KIND-OF-RESULT is the symbol `list',this function returns a list of all the objectsthat satisfy the criterion.@end example@noindentdoes not make a hyperlink to the documentation, irrelevant here, of thefunction @code{list}.@itemDon't write key sequences directly in documentation strings. Instead,use the @samp{\\[@dots{}]} construct to stand for them. For example,instead of writing @samp{C-f}, write the construct@samp{\\[forward-char]}. When Emacs displays the documentation string,it substitutes whatever key is currently bound to @code{forward-char}.(This is normally @samp{C-f}, but it may be some other character if theuser has moved key bindings.) @xref{Keys in Documentation}.@itemIn documentation strings for a major mode, you will want to refer to thekey bindings of that mode's local map, rather than global ones.Therefore, use the construct @samp{\\<@dots{}>} once in thedocumentation string to specify which key map to use. Do this beforethe first use of @samp{\\[@dots{}]}. The text inside the@samp{\\<@dots{}>} should be the name of the variable containing thelocal keymap for the major mode.It is not practical to use @samp{\\[@dots{}]} very many times, becausedisplay of the documentation string will become slow. So use this todescribe the most important commands in your major mode, and then use@samp{\\@{@dots{}@}} to display the rest of the mode's keymap.@end itemize@node Comment Tips@section Tips on Writing Comments We recommend these conventions for where to put comments and how toindent them:@table @samp@item ;Comments that start with a single semicolon, @samp{;}, should all bealigned to the same column on the right of the source code. Suchcomments usually explain how the code on the same line does its job. InLisp mode and related modes, the @kbd{M-;} (@code{indent-for-comment})command automatically inserts such a @samp{;} in the right place, oraligns such a comment if it is already present.This and following examples are taken from the Emacs sources.@smallexample@group(setq base-version-list ; there was a base (assoc (substring fn 0 start-vn) ; version to which file-version-assoc-list)) ; this looks like ; a subversion@end group@end smallexample@item ;;Comments that start with two semicolons, @samp{;;}, should be aligned tothe same level of indentation as the code. Such comments usuallydescribe the purpose of the following lines or the state of the programat that point. For example:@smallexample@group(prog1 (setq auto-fill-function @dots{} @dots{} ;; update mode line (force-mode-line-update)))@end group@end smallexampleEvery function that has no documentation string (presumably one that isused only internally within the package it belongs to), should haveinstead a two-semicolon comment right before the function, explainingwhat the function does and how to call it properly. Explain preciselywhat each argument means and how the function interprets its possiblevalues.@item ;;;Comments that start with three semicolons, @samp{;;;}, should start atthe left margin. Such comments are used outside function definitions tomake general statements explaining the design principles of the program.For example:@smallexample@group;;; This Lisp code is run in Emacs;;; when it is to operate as a server;;; for other processes.@end group@end smallexampleAnother use for triple-semicolon comments is for commenting out lineswithin a function. We use triple-semicolons for this precisely so thatthey remain at the left margin.@smallexample(defun foo (a);;; This is no longer necessary.;;; (force-mode-line-update) (message "Finished with %s" a))@end smallexample@item ;;;;Comments that start with four semicolons, @samp{;;;;}, should be alignedto the left margin and are used for headings of major sections of aprogram. For example:@smallexample;;;; The kill ring@end smallexample@end table@noindentThe indentation commands of the Lisp modes in Emacs, such as @kbd{M-;}(@code{indent-for-comment}) and @key{TAB} (@code{lisp-indent-line}),automatically indent comments according to these conventions,depending on the number of semicolons. @xref{Comments,,Manipulating Comments, emacs, The GNU Emacs Manual}.@node Library Headers@section Conventional Headers for Emacs Libraries@cindex header comments@cindex library header comments Emacs has conventions for using special comments in Lisp librariesto divide them into sections and give information such as who wrotethem. This section explains these conventions. First, an example:@smallexample@group;;; lisp-mnt.el --- minor mode for Emacs Lisp maintainers;; Copyright (C) 1992 Free Software Foundation, Inc.@end group;; Author: Eric S. Raymond <esr@@snark.thyrsus.com>;; Maintainer: Eric S. Raymond <esr@@snark.thyrsus.com>;; Created: 14 Jul 1992;; Version: 1.2@group;; Keywords: docs;; This file is part of GNU Emacs.@dots{};; Free Software Foundation, Inc., 59 Temple Place - Suite 330,;; Boston, MA 02111-1307, USA.@end group@end smallexample The very first line should have this format:@example;;; @var{filename} --- @var{description}@end example@noindentThe description should be complete in one line. After the copyright notice come several @dfn{header comment} lines,each beginning with @samp{;; @var{header-name}:}. Here is a table ofthe conventional possibilities for @var{header-name}:@table @samp@item AuthorThis line states the name and net address of at least the principalauthor of the library.If there are multiple authors, you can list them on continuation linesled by @code{;;} and a tab character, like this:@smallexample@group;; Author: Ashwin Ram <Ram-Ashwin@@cs.yale.edu>;; Dave Sill <de5@@ornl.gov>;; Dave Brennan <brennan@@hal.com>;; Eric Raymond <esr@@snark.thyrsus.com>@end group@end smallexample@item MaintainerThis line should contain a single name/address as in the Author line, oran address only, or the string @samp{FSF}. If there is no maintainerline, the person(s) in the Author field are presumed to be themaintainers. The example above is mildly bogus because the maintainerline is redundant.The idea behind the @samp{Author} and @samp{Maintainer} lines is to makepossible a Lisp function to ``send mail to the maintainer'' withouthaving to mine the name out by hand.Be sure to surround the network address with @samp{<@dots{}>} ifyou include the person's full name as well as the network address.@item CreatedThis optional line gives the original creation date of thefile. For historical interest only.@item VersionIf you wish to record version numbers for the individual Lisp program, putthem in this line.@item Adapted-ByIn this header line, place the name of the person who adapted thelibrary for installation (to make it fit the style conventions, forexample).@item KeywordsThis line lists keywords for the @code{finder-by-keyword} help command.Please use that command to see a list of the meaningful keywords.This field is important; it's how people will find your package whenthey're looking for things by topic area. To separate the keywords, youcan use spaces, commas, or both.@end table Just about every Lisp library ought to have the @samp{Author} and@samp{Keywords} header comment lines. Use the others if they areappropriate. You can also put in header lines with other headernames---they have no standard meanings, so they can't do any harm. We use additional stylized comments to subdivide the contents of thelibrary file. Here is a table of them:@table @samp@item ;;; Commentary:This begins introductory comments that explain how the library works.It should come right after the copying permissions, terminated by a@samp{Change Log}, @samp{History} or @samp{Code} comment line. Thistext is used by the Finder package, so it should make sense in thatcontext.@item ;;; DocumentationThis has been used in some files in place of @samp{;;; Commentary:},but @samp{;;; Commentary:} is preferred.@item ;;; Change Log:This begins change log information stored in the library file (if youstore the change history there). For most of the Lispfiles distributed with Emacs, the change history is kept in the file@file{ChangeLog} and not in the source file at all; these files donot have a @samp{;;; Change Log:} line.@item ;;; Code:This begins the actual code of the program.@item ;;; @var{filename} ends hereThis is the @dfn{footer line}; it appears at the very end of the file.Its purpose is to enable people to detect truncated versions of the filefrom the lack of a footer line.@end table