\input texinfo @c -*-texinfo-*-
@comment %**start of header
-@setfilename ../../info/eintr
+@setfilename ../../info/eintr.info
@c setfilename emacs-lisp-intro.info
@c sethtmlfilename emacs-lisp-intro.html
@settitle Programming in Emacs Lisp
+@documentencoding UTF-8
@syncodeindex vr cp
@syncodeindex fn cp
@finalout
@include emacsver.texi
-@c ---------
+@c ================ How to Print a Book in Various Sizes ================
+
+@c This book can be printed in any of three different sizes.
+@c Set the following @-commands appropriately.
+
+@c 7 by 9.25 inches:
+@c @smallbook
+@c @clear largebook
+
+@c 8.5 by 11 inches:
+@c @c smallbook
+@c @set largebook
+
+@c European A4 size paper:
+@c @c smallbook
+@c @afourpaper
+@c @set largebook
+
+@c (Note: if you edit the book so as to change the length of the
+@c table of contents, you may have to change the value of `pageno' below.)
+
@c <<<< For hard copy printing, this file is now
@c set for smallbook, which works for all sizes
@c of paper, and with PostScript figures >>>>
+
@set smallbook
@ifset smallbook
@smallbook
@clear largebook
@end ifset
+
+@c ================ Included Figures ================
+
+@c If you clear this, the figures will be printed as ASCII diagrams
+@c rather than PostScript/PDF.
+@c (This is not relevant to Info, since Info only handles ASCII.)
@set print-postscript-figures
-@c set largebook
@c clear print-postscript-figures
-@c ---------
@comment %**end of header
@set edition-number 3.10
@set update-date 28 October 2009
-@c ================ Included Figures ================
-
-@c Set print-postscript-figures if you print PostScript figures.
-@c If you clear this, the ten figures will be printed as ASCII diagrams.
-@c (This is not relevant to Info, since Info only handles ASCII.)
-@c Your site may require editing changes to print PostScript; in this
-@c case, search for `print-postscript-figures' and make appropriate changes.
-
-@c ================ How to Print a Book in Various Sizes ================
-
-@c This book can be printed in any of three different sizes.
-@c In the above header, set @-commands appropriately.
-
-@c 7 by 9.25 inches:
-@c @smallbook
-@c @clear largebook
-
-@c 8.5 by 11 inches:
-@c @c smallbook
-@c @set largebook
-
-@c European A4 size paper:
-@c @c smallbook
-@c @afourpaper
-@c @set largebook
-
-@c (Note: if you edit the book so as to change the length of the
-@c table of contents, you may have to change the value of `pageno' below.)
-
-@c ================ End of Formatting Sections ================
-
@c For next or subsequent edition:
@c create function using with-output-to-temp-buffer
@c create a major mode, with keymaps
@c ----------------------------------------------------
-@dircategory GNU Emacs Lisp
+@dircategory Emacs lisp
@direntry
-* Emacs Lisp Intro: (eintr).
- A simple introduction to Emacs Lisp programming.
+* Emacs Lisp Intro: (eintr). A simple introduction to Emacs Lisp programming.
@end direntry
@copying
@ifnottex
Distributed with Emacs version @value{EMACSVER}.
@end ifnottex
-@ifset WWW_GNU_ORG
-@html
-<p>The homepage for GNU Emacs is at
-<a href="http://www.gnu.org/software/emacs/">http://www.gnu.org/software/emacs/</a>.
-<br>To view this manual in other formats, click
-<a href="/software/emacs/emacs-lisp-intro/emacs-lisp-intro.html">here</a>.
-@end html
-@end ifset
@sp 1
-Copyright @copyright{} 1990--1995, 1997, 2001--2013 Free Software
+Copyright @copyright{} 1990--1995, 1997, 2001--2014 Free Software
Foundation, Inc.
@sp 1
@sp 1
ISBN 1-882114-43-4
+@quotation
Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License, Version 1.3 or
any later version published by the Free Software Foundation; there
(a) The FSF's Back-Cover Text is: ``You have the freedom to
copy and modify this GNU manual. Buying copies from the FSF
supports it in developing GNU and promoting software freedom.''
+@end quotation
@end copying
@c half title; two lines here, so do not use `shorttitlepage'
@node Top
@top An Introduction to Programming in Emacs Lisp
+@ifset WWW_GNU_ORG
+@html
+<p>The homepage for GNU Emacs is at
+<a href="/software/emacs/">http://www.gnu.org/software/emacs/</a>.<br>
+To view this manual in other formats, click
+<a href="/software/emacs/manual/eintr.html">here</a>.
+@end html
+@end ifset
+
@insertcopying
This master menu first lists each chapter and index; then it lists
* Default Configuration::
* Site-wide Init:: You can write site-wide init files.
* defcustom:: Emacs will write code for you.
-* Beginning a .emacs File:: How to write a @code{.emacs file}.
+* Beginning init File:: How to write a @file{.emacs} init file.
* Text and Auto-fill:: Automatically wrap lines.
* Mail Aliases:: Use abbreviations for email addresses.
* Indent Tabs Mode:: Don't use tabs with @TeX{}
If you don't know GNU Emacs, you can still read this document
profitably. However, I recommend you learn Emacs, if only to learn to
move around your computer screen. You can teach yourself how to use
-Emacs with the on-line tutorial. To use it, type @kbd{C-h t}. (This
+Emacs with the built-in tutorial. To use it, type @kbd{C-h t}. (This
means you press and release the @key{CTRL} key and the @kbd{h} at the
same time, and then press and release @kbd{t}.)
@flushright
Robert J. Chassell
+@ifnothtml
@email{bob@@gnu.org}
+@end ifnothtml
+@ifhtml
+bob@@gnu.org
+@end ifhtml
@end flushright
@c ================ Beginning of main text ================
of drawers. The function definition is put in one drawer, the value in
another, and so on. What is put in the drawer holding the value can be
changed without affecting the contents of the drawer holding the
-function definition, and vice-verse.
+function definition, and vice versa.
@menu
* fill-column Example::
evaluate the symbols as variables. @xref{Variables}.)
In spite of the distinction between files and buffers, you will often
-find that people refer to a file when they mean a buffer and vice-verse.
+find that people refer to a file when they mean a buffer and vice versa.
Indeed, most people say, ``I am editing a file,'' rather than saying,
``I am editing a buffer which I will soon save to a file.'' It is
almost always clear from context what people mean. When dealing with
end of the comment. To stretch a comment over two or more lines, begin
each line with a semicolon.
-@xref{Beginning a .emacs File, , Beginning a @file{.emacs}
+@xref{Beginning init File, , Beginning a @file{.emacs}
File}, and @ref{Comments, , Comments, elisp, The GNU Emacs Lisp
Reference Manual}, for more about comments.
rather than a general library. Each library, or file, contains
functions that relate to a particular topic or activity, such as
@file{abbrev.el} for handling abbreviations and other typing
-shortcuts, and @file{help.el} for on-line help. (Sometimes several
+shortcuts, and @file{help.el} for help. (Sometimes several
libraries provide code for a single activity, as the various
@file{rmail@dots{}} files provide code for reading electronic mail.)
In @cite{The GNU Emacs Manual}, you will see sentences such as ``The
@noindent
@code{not} is a function that returns true if its argument is false
and false if its argument is true. So if @code{(bufferp buffer)}
-returns true, the @code{not} expression returns false and vice-verse:
+returns true, the @code{not} expression returns false and vice versa:
what is ``not true'' is false and what is ``not false'' is true.
Using this test, the @code{if} expression works as follows: when the
(/ (+ 10 (* size (prefix-numeric-value arg)))
10)))
(point-min))))
- (if arg (forward-line 1)))
+ (if (and arg (not (consp arg))) (forward-line 1)))
@end group
@end smallexample
invoked with an argument:
@smallexample
-(if arg (forward-line 1)))
+(if (and arg (not (consp arg))) (forward-line 1))
@end smallexample
@noindent
means that the cursor is always located @emph{at least} the requested
tenths of the way through the buffer, which is a nicety that is,
perhaps, not necessary, but which, if it did not occur, would be sure
-to draw complaints.
-
-On the other hand, it also means that if you specify the command with
-a @kbd{C-u}, but without a number, that is to say, if the `raw prefix
-argument' is simply a cons cell, then the command puts you at the
-beginning of the second line @dots{} I don't know whether this is
-intended or whether no one has dealt with the code to avoid this
-happening.
+to draw complaints. (The @code{(not (consp arg))} portion is so that
+if you specify the command with a @kbd{C-u}, but without a number,
+that is to say, if the `raw prefix argument' is simply a cons cell,
+the command does not put you at the beginning of the second line.)
@node Second Buffer Related Review
@section Review
@section @code{zap-to-char}
@findex zap-to-char
-@c FIXME remove obsolete stuff
-The @code{zap-to-char} function changed little between GNU Emacs
-version 19 and GNU Emacs version 22. However, @code{zap-to-char}
-calls another function, @code{kill-region}, which enjoyed a major
-rewrite.
-
-The @code{kill-region} function in Emacs 19 is complex, but does not
-use code that is important at this time. We will skip it.
-
-The @code{kill-region} function in Emacs 22 is easier to read than the
-same function in Emacs 19 and introduces a very important concept,
-that of error handling. We will walk through the function.
-
-But first, let us look at the interactive @code{zap-to-char} function.
+Let us look at the interactive @code{zap-to-char} function.
@menu
* Complete zap-to-char:: The complete implementation.
The arguments are @code{beg} and @code{end} and the function is
interactive with @code{"r"}, so the two arguments must refer to the
-beginning and end of the region. If you have been reading though this
+beginning and end of the region. If you have been reading through this
document from the beginning, understanding these parts of a function is
almost becoming routine.
@sp 1
@tex
@center @image{cons-1}
-%%%% old method of including an image
-% \input /usr/local/lib/tex/inputs/psfig.tex
-% \centerline{\psfig{figure=/usr/local/lib/emacs/man/cons-1.eps}}
-% \catcode`\@=0 %
@end tex
@sp 1
@end ifset
@sp 1
@tex
@center @image{cons-2}
-%%%% old method of including an image
-% \input /usr/local/lib/tex/inputs/psfig.tex
-% \centerline{\psfig{figure=/usr/local/lib/emacs/man/cons-2.eps}}
-% \catcode`\@=0 %
@end tex
@sp 1
@end ifset
@sp 1
@tex
@center @image{cons-2a}
-%%%% old method of including an image
-% \input /usr/local/lib/tex/inputs/psfig.tex
-% \centerline{\psfig{figure=/usr/local/lib/emacs/man/cons-2a.eps}}
-% \catcode`\@=0 %
@end tex
@sp 1
@end ifset
@sp 1
@tex
@center @image{cons-3}
-%%%% old method of including an image
-% \input /usr/local/lib/tex/inputs/psfig.tex
-% \centerline{\psfig{figure=/usr/local/lib/emacs/man/cons-3.eps}}
-% \catcode`\@=0 %
@end tex
@sp 1
@end ifset
@sp 1
@tex
@center @image{cons-4}
-%%%% old method of including an image
-% \input /usr/local/lib/tex/inputs/psfig.tex
-% \centerline{\psfig{figure=/usr/local/lib/emacs/man/cons-4.eps}}
-% \catcode`\@=0 %
@end tex
@sp 1
@end ifset
being a chest of drawers. The function definition is put in one
drawer, the value in another, and so on. What is put in the drawer
holding the value can be changed without affecting the contents of the
-drawer holding the function definition, and vice-verse.
+drawer holding the function definition, and vice versa.
Actually, what is put in each drawer is the address of the value or
function definition. It is as if you found an old chest in the attic,
@sp 1
@tex
@center @image{drawers}
-%%%% old method of including an image
-% \input /usr/local/lib/tex/inputs/psfig.tex
-% \centerline{\psfig{figure=/usr/local/lib/emacs/man/drawers.eps}}
-% \catcode`\@=0 %
@end tex
@sp 1
@end ifset
@sp 1
@tex
@center @image{cons-5}
-%%%% old method of including an image
-% \input /usr/local/lib/tex/inputs/psfig.tex
-% \centerline{\psfig{figure=/usr/local/lib/emacs/man/cons-5.eps}}
-% \catcode`\@=0 %
@end tex
@sp 1
@end ifset
@node Every
@unnumberedsubsubsec Recursive Pattern: @emph{every}
@cindex Every, type of recursive pattern
-@cindex Recursive pattern: every
+@cindex Recursive pattern - every
In the @code{every} recursive pattern, an action is performed on every
element of a list.
@node Accumulate
@unnumberedsubsubsec Recursive Pattern: @emph{accumulate}
@cindex Accumulate, type of recursive pattern
-@cindex Recursive pattern: accumulate
+@cindex Recursive pattern - accumulate
Another recursive pattern is called the @code{accumulate} pattern. In
the @code{accumulate} recursive pattern, an action is performed on
@node Keep
@unnumberedsubsubsec Recursive Pattern: @emph{keep}
@cindex Keep, type of recursive pattern
-@cindex Recursive pattern: keep
+@cindex Recursive pattern - keep
A third recursive pattern is called the @code{keep} pattern.
In the @code{keep} recursive pattern, each element of a list is tested;
@node No deferment solution
@subsection No Deferment Solution
@cindex No deferment solution
-@cindex Defermentless solution
@cindex Solution without deferment
The solution to the problem of deferred operations is to write in a
@noindent
This @code{while} loop has us searching forward for
@code{sp-parstart}, which is the combination of possible whitespace
-with a the local value of the start of a paragraph or of a paragraph
+with the local value of the start of a paragraph or of a paragraph
separator. (The latter two are within an expression starting
@code{\(?:} so that they are not referenced by the
@code{match-beginning} function.)
@end itemize
@node Counting Words
-@chapter Counting: Repetition and Regexps
+@chapter Counting via Repetition and Regexps
@cindex Repetition for word counting
@cindex Regular expressions for word counting
Our next project is to count the number of words in a function
definition. Clearly, this can be done using some variant of
-@code{@value{COUNT-WORDS}}. @xref{Counting Words, , Counting Words:
+@code{@value{COUNT-WORDS}}. @xref{Counting Words, , Counting via
Repetition and Regexps}. If we are just going to count the words in
one definition, it is easy enough to mark the definition with the
@kbd{C-M-h} (@code{mark-defun}) command, and then call
@c !!! 22.1.1 lisp sources location here
@smallexample
(lengths-list-file
- "/usr/local/share/emacs/22.1.1/lisp/emacs-lisp/debug.el")
+ "/usr/local/share/emacs/22.1/lisp/emacs-lisp/debug.el")
@end smallexample
@noindent
-(You may need to change the pathname of the file; the one here is for
-GNU Emacs version 22.1.1. To change the expression, copy it to
+You may need to change the pathname of the file; the one here is for
+GNU Emacs version 22.1. To change the expression, copy it to
the @file{*scratch*} buffer and edit it.
@need 1200
@noindent
-(Also, to see the full length of the list, rather than a truncated
+Also, to see the full length of the list, rather than a truncated
version, you may have to evaluate the following:
+@c We do not want to insert, so do not mention the zero prefix argument.
@smallexample
(custom-set-variables '(eval-expression-print-length nil))
(75 41 80 62 20 45 44 68 45 12 34 235)
@end smallexample
-(The newer version of @file{debug.el} contains more defuns than the
+@noindent
+The newer version of @file{debug.el} contains more defuns than the
earlier one; and my new machine is much faster than the old one.)
Note that the length of the last definition in the file is first in
directory, checking what needs to be done; and we will use a recursive
call to repeat the actions on each sub-directory. The recursive
pattern is `accumulate'
-(@pxref{Accumulate, , Recursive Pattern: @emph{accumulate}}),
+(@pxref{Accumulate}),
using @code{append} as the combiner.
@ignore
* Default Configuration::
* Site-wide Init:: You can write site-wide init files.
* defcustom:: Emacs will write code for you.
-* Beginning a .emacs File:: How to write a @code{.emacs file}.
+* Beginning init File:: How to write a @file{.emacs} init file.
* Text and Auto-fill:: Automatically wrap lines.
* Mail Aliases:: Use abbreviations for email addresses.
* Indent Tabs Mode:: Don't use tabs with @TeX{}
set by @code{defconst}. (You can change it; the value set is a
variable; but please do not.)
-@node Beginning a .emacs File
+@node Beginning init File
@section Beginning a @file{.emacs} File
@cindex @file{.emacs} file, beginning of
first use such a function, while its containing file is evaluated.
Rarely used functions are frequently autoloaded. The
-@file{loaddefs.el} library contains hundreds of autoloaded functions,
-from @code{bookmark-set} to @code{wordstar-mode}. Of course, you may
+@file{loaddefs.el} library contains thousands of autoloaded functions,
+from @code{5x5} to @code{zone}. Of course, you may
come to use a `rare' function frequently. When you do, you should
load that function's file with a @code{load} expression in your
@file{.emacs} file.
@group
;; Set calendar highlighting colors
-(setq calendar-load-hook
+(add-hook 'calendar-load-hook
(lambda ()
(set-face-foreground 'diary-face "skyblue")
(set-face-background 'holiday-face "slate blue")
You can walk through the execution of a function, line by line, or run
quickly until reaching a @dfn{breakpoint} where execution stops.
-Edebug is described in @ref{edebug, , Edebug, elisp, The GNU Emacs
+Edebug is described in @ref{Edebug, , , elisp, The GNU Emacs
Lisp Reference Manual}.
@need 1250
changing values of various expressions; you can find out how many
times a function is called, and more.
-Edebug is described in @ref{edebug, , Edebug, elisp, The GNU Emacs
+Edebug is described in @ref{Edebug, , , elisp, The GNU Emacs
Lisp Reference Manual}.
@need 1500
experts, but for people who know what you know. (The @cite{Reference
Manual} comes with the standard GNU Emacs distribution. Like this
introduction, it comes as a Texinfo source file, so you can read it
-on-line and as a typeset, printed book.)
+on your computer and as a typeset, printed book.)
-Go to the other on-line help that is part of GNU Emacs: the on-line
+Go to the other built-in help that is part of GNU Emacs: the built-in
documentation for all functions and variables, and @code{find-tag},
the program that takes you to sources.
@noindent
If we want to multiply 3 by 7, we can write:
-@c !!! Clear print-postscript-figures if the computer formatting this
-@c document is too small and cannot handle all the diagrams and figures.
@c clear print-postscript-figures
-@c set print-postscript-figures
@c lambda example diagram #1
@ifnottex
@smallexample
@sp 1
@tex
@center @image{lambda-1}
-%%%% old method of including an image
-% \input /usr/local/lib/tex/inputs/psfig.tex
-% \centerline{\psfig{figure=/usr/local/lib/emacs/man/lambda-1.eps}}
-% \catcode`\@=0 %
@end tex
@sp 1
@end ifset
@sp 1
@tex
@center @image{lambda-2}
-%%%% old method of including an image
-% \input /usr/local/lib/tex/inputs/psfig.tex
-% \centerline{\psfig{figure=/usr/local/lib/emacs/man/lambda-2.eps}}
-% \catcode`\@=0 %
@end tex
@sp 1
@end ifset
@sp 1
@tex
@center @image{lambda-3}
-%%%% old method of including an image
-% \input /usr/local/lib/tex/inputs/psfig.tex
-% \centerline{\psfig{figure=/usr/local/lib/emacs/man/lambda-3.eps}}
-% \catcode`\@=0 %
@end tex
@sp 1
@end ifset