Mercurial > emacs

annotate doc/lispintro/emacs-lisp-intro.texi @ 106773:d2c6973afc86

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
* xfns.c (Fx_create_frame): Don't create frame larger than display by default bug#3643.
author Jan D. <jan.h.d@swipnet.se>
date Sat, 09 Jan 2010 14:28:02 +0100 (2010-01-09)
parents 2ae01aa75e84
children 1d1d5d9bd884
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
83955
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1 \input texinfo @c -*-texinfo-*-
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2 @comment %**start of header
83965
f0912c72f201 (setfilename): Go up one more level.
Glenn Morris <rgm@gnu.org>
parents: 83955
diff changeset
3 @setfilename ../../info/eintr
83955
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4 @c setfilename emacs-lisp-intro.info
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5 @c sethtmlfilename emacs-lisp-intro.html
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6 @settitle Programming in Emacs Lisp
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7 @syncodeindex vr cp
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8 @syncodeindex fn cp
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9 @finalout
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11 @c ---------
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12 @c <<<< For hard copy printing, this file is now
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13 @c set for smallbook, which works for all sizes
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14 @c of paper, and with Postscript figures >>>>
98525
b6395ec3de45 formatting fixes for new printed edition
Karl Berry <karl@gnu.org>
parents: 94896
diff changeset
15 @set smallbook
b6395ec3de45 formatting fixes for new printed edition
Karl Berry <karl@gnu.org>
parents: 94896
diff changeset
16 @ifset smallbook
83955
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17 @smallbook
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18 @clear largebook
98525
b6395ec3de45 formatting fixes for new printed edition
Karl Berry <karl@gnu.org>
parents: 94896
diff changeset
19 @end ifset
83955
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20 @set print-postscript-figures
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21 @c set largebook
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22 @c clear print-postscript-figures
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
23 @c ---------
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
24
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
25 @comment %**end of header
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
26
98525
b6395ec3de45 formatting fixes for new printed edition
Karl Berry <karl@gnu.org>
parents: 94896
diff changeset
27 @c per rms and peterb, use 10pt fonts for the main text, mostly to
102151
328f4b370b74 Remove duplicate words.
Juanma Barranquero <lekktu@gmail.com>
parents: 100974
diff changeset
28 @c save on paper cost.
98525
b6395ec3de45 formatting fixes for new printed edition
Karl Berry <karl@gnu.org>
parents: 94896
diff changeset
29 @c Do this inside @tex for now, so current makeinfo does not complain.
b6395ec3de45 formatting fixes for new printed edition
Karl Berry <karl@gnu.org>
parents: 94896
diff changeset
30 @tex
b6395ec3de45 formatting fixes for new printed edition
Karl Berry <karl@gnu.org>
parents: 94896
diff changeset
31 @ifset smallbook
b6395ec3de45 formatting fixes for new printed edition
Karl Berry <karl@gnu.org>
parents: 94896
diff changeset
32 @fonttextsize 10
105790
a753ed9de6b4 removed lines 33 and 34 of emacs-lisp-intro.texi which said
Robert J. Chassell <bob@rattlesnake.com>
parents: 105781
diff changeset
33
98525
b6395ec3de45 formatting fixes for new printed edition
Karl Berry <karl@gnu.org>
parents: 94896
diff changeset
34 @end ifset
b6395ec3de45 formatting fixes for new printed edition
Karl Berry <karl@gnu.org>
parents: 94896
diff changeset
35 \global\hbadness=6666 % don't worry about not-too-underfull boxes
b6395ec3de45 formatting fixes for new printed edition
Karl Berry <karl@gnu.org>
parents: 94896
diff changeset
36 @end tex
b6395ec3de45 formatting fixes for new printed edition
Karl Berry <karl@gnu.org>
parents: 94896
diff changeset
37
105790
a753ed9de6b4 removed lines 33 and 34 of emacs-lisp-intro.texi which said
Robert J. Chassell <bob@rattlesnake.com>
parents: 105781
diff changeset
38 @set edition-number 3.10
a753ed9de6b4 removed lines 33 and 34 of emacs-lisp-intro.texi which said
Robert J. Chassell <bob@rattlesnake.com>
parents: 105781
diff changeset
39 @set update-date 28 October 2009
105781
102fa2b8ed58 Minor change, bump Emacs version
Robert J. Chassell <bob@rattlesnake.com>
parents: 104626
diff changeset
40
83955
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
41 @ignore
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
42 ## Summary of shell commands to create various output formats:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
43
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
44 pushd /usr/local/src/emacs/lispintro/
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
45 ## pushd /u/intro/
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
46
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
47 ## Info output
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
48 makeinfo --paragraph-indent=0 --verbose emacs-lisp-intro.texi
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
49
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
50 ## ;; (progn (when (bufferp (get-buffer "*info*")) (kill-buffer "*info*")) (info "/usr/local/src/emacs/info/eintr"))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
51
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
52 ## DVI output
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
53 texi2dvi emacs-lisp-intro.texi
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
54
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
55 ## xdvi -margins 24pt -topmargin 4pt -offsets 24pt -geometry 760x1140 -s 5 -useTeXpages -mousemode 1 emacs-lisp-intro.dvi &
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
56
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
57 ## HTML output
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
58 makeinfo --html --no-split --verbose emacs-lisp-intro.texi
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
59
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
60 ## galeon emacs-lisp-intro.html
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
61
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
62 ## Plain text output
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
63 makeinfo --fill-column=70 --no-split --paragraph-indent=0 \
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
64 --verbose --no-headers --output=emacs-lisp-intro.txt emacs-lisp-intro.texi
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
65
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
66 popd
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
67
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
68 # as user `root'
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
69 # insert thumbdrive
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
70 mtusb # mount -v -t ext3 /dev/sda /mnt
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
71 cp -v /u/intro/emacs-lisp-intro.texi /mnt/backup/intro/emacs-lisp-intro.texi
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
72 umtusb # umount -v /mnt
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
73 # remove thumbdrive
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
74
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
75 ## Other shell commands
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
76
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
77 pushd /usr/local/src/emacs/lispintro/
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
78 ## pushd /u/intro/
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
79
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
80 ## PDF
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
81 texi2dvi --pdf emacs-lisp-intro.texi
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
82 # xpdf emacs-lisp-intro.pdf &
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
83
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
84 ## DocBook -- note file extension
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
85 makeinfo --docbook --no-split --paragraph-indent=0 \
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
86 --verbose --output=emacs-lisp-intro.docbook emacs-lisp-intro.texi
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
87
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
88 ## XML with a Texinfo DTD -- note file extension
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
89 makeinfo --xml --no-split --paragraph-indent=0 \
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
90 --verbose --output=emacs-lisp-intro.texinfoxml emacs-lisp-intro.texi
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
91
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
92 ## PostScript (needs DVI)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
93 # gv emacs-lisp-intro.ps &
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
94 # Create DVI if we lack it
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
95 # texi2dvi emacs-lisp-intro.texi
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
96 dvips emacs-lisp-intro.dvi -o emacs-lisp-intro.ps
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
97
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
98 ## RTF (needs HTML)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
99 # Use OpenOffice to view RTF
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
100 # Create HTML if we lack it
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
101 # makeinfo --no-split --html emacs-lisp-intro.texi
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
102 /usr/local/src/html2rtf.pl emacs-lisp-intro.html
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
103
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
104 ## LaTeX (needs RTF)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
105 /usr/bin/rtf2latex emacs-lisp-intro.rtf
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
106
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
107 popd
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
108
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
109 @end ignore
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
110
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
111 @c ================ Included Figures ================
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
112
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
113 @c Set print-postscript-figures if you print PostScript figures.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
114 @c If you clear this, the ten figures will be printed as ASCII diagrams.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
115 @c (This is not relevant to Info, since Info only handles ASCII.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
116 @c Your site may require editing changes to print PostScript; in this
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
117 @c case, search for `print-postscript-figures' and make appropriate changes.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
118
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
119 @c ================ How to Create an Info file ================
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
120
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
121 @c If you have `makeinfo' installed, run the following command
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
122
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
123 @c makeinfo emacs-lisp-intro.texi
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
124
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
125 @c or, if you want a single, large Info file, and no paragraph indents:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
126 @c makeinfo --no-split --paragraph-indent=0 --verbose emacs-lisp-intro.texi
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
127
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
128 @c After creating the Info file, edit your Info `dir' file, if the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
129 @c `dircategory' section below does not enable your system to
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
130 @c install the manual automatically.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
131 @c (The `dir' file is often in the `/usr/local/share/info/' directory.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
132
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
133 @c ================ How to Create an HTML file ================
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
134
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
135 @c To convert to HTML format
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
136 @c makeinfo --html --no-split --verbose emacs-lisp-intro.texi
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
137
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
138 @c ================ How to Print a Book in Various Sizes ================
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
139
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
140 @c This book can be printed in any of three different sizes.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
141 @c In the above header, set @-commands appropriately.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
142
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
143 @c 7 by 9.25 inches:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
144 @c @smallbook
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
145 @c @clear largebook
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
146
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
147 @c 8.5 by 11 inches:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
148 @c @c smallbook
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
149 @c @set largebook
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
150
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
151 @c European A4 size paper:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
152 @c @c smallbook
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
153 @c @afourpaper
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
154 @c @set largebook
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
155
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
156 @c ================ How to Typeset and Print ================
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
157
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
158 @c If you do not include PostScript figures, run either of the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
159 @c following command sequences, or similar commands suited to your
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
160 @c system:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
161
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
162 @c texi2dvi emacs-lisp-intro.texi
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
163 @c lpr -d emacs-lisp-intro.dvi
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
164
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
165 @c or else:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
166
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
167 @c tex emacs-lisp-intro.texi
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
168 @c texindex emacs-lisp-intro.??
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
169 @c tex emacs-lisp-intro.texi
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
170 @c lpr -d emacs-lisp-intro.dvi
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
171
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
172 @c If you include the PostScript figures, and you have old software,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
173 @c you may need to convert the .dvi file to a .ps file before
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
174 @c printing. Run either of the following command sequences, or one
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
175 @c similar:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
176 @c
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
177 @c dvips -f < emacs-lisp-intro.dvi > emacs-lisp-intro.ps
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
178 @c
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
179 @c or else:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
180 @c
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
181 @c postscript -p < emacs-lisp-intro.dvi > emacs-lisp-intro.ps
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
182 @c
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
183
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
184 @c (Note: if you edit the book so as to change the length of the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
185 @c table of contents, you may have to change the value of `pageno' below.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
186
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
187 @c ================ End of Formatting Sections ================
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
188
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
189 @c For next or subsequent edition:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
190 @c create function using with-output-to-temp-buffer
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
191 @c create a major mode, with keymaps
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
192 @c run an asynchronous process, like grep or diff
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
193
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
194 @c For 8.5 by 11 inch format: do not use such a small amount of
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
195 @c whitespace between paragraphs as smallbook format
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
196 @ifset largebook
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
197 @tex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
198 \global\parskip 6pt plus 1pt
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
199 @end tex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
200 @end ifset
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
201
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
202 @c For all sized formats: print within-book cross
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
203 @c reference with ``...'' rather than [...]
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
204
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
205 @c This works with the texinfo.tex file, version 2003-05-04.08,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
206 @c in the Texinfo version 4.6 of the 2003 Jun 13 distribution.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
207
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
208 @tex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
209 \if \xrefprintnodename
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
210 \global\def\xrefprintnodename#1{\unskip, ``#1''}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
211 \else
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
212 \global\def\xrefprintnodename#1{ ``#1''}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
213 \fi
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
214 % \global\def\xrefprintnodename#1{, ``#1''}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
215 @end tex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
216
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
217 @c ----------------------------------------------------
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
218
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
219 @dircategory Emacs
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
220 @direntry
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
221 * Emacs Lisp Intro: (eintr).
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
222 A simple introduction to Emacs Lisp programming.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
223 @end direntry
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
224
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
225 @copying
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
226 This is an @cite{Introduction to Programming in Emacs Lisp}, for
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
227 people who are not programmers.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
228 @sp 1
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
229 Edition @value{edition-number}, @value{update-date}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
230 @sp 1
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
231 Copyright @copyright{} 1990, 1991, 1992, 1993, 1994, 1995, 1997, 2001,
100974
cb5d2387102c Add 2009 to copyright years.
Glenn Morris <rgm@gnu.org>
parents: 99703
diff changeset
232 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009 Free Software Foundation, Inc.
83955
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
233 @sp 1
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
234
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
235 @iftex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
236 Published by the:@*
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
237
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
238 GNU Press, @hfill @uref{http://www.gnupress.org}@*
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
239 a division of the @hfill General: @email{press@@gnu.org}@*
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
240 Free Software Foundation, Inc. @hfill Orders:@w{ } @email{sales@@gnu.org}@*
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
241 51 Franklin Street, Fifth Floor @hfill Tel: +1 (617) 542-5942@*
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
242 Boston, MA 02110-1301 USA @hfill Fax: +1 (617) 542-2652@*
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
243 @end iftex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
244
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
245 @ifnottex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
246 Published by the:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
247
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
248 @example
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
249 GNU Press, Website: http://www.gnupress.org
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
250 a division of the General: press@@gnu.org
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
251 Free Software Foundation, Inc. Orders: sales@@gnu.org
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
252 51 Franklin Street, Fifth Floor Tel: +1 (617) 542-5942
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
253 Boston, MA 02110-1301 USA Fax: +1 (617) 542-2652
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
254 @end example
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
255 @end ifnottex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
256
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
257 @sp 1
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
258 @c Printed copies are available for $30 each.@*
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
259 ISBN 1-882114-43-4
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
260
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
261 Permission is granted to copy, distribute and/or modify this document
99703
fe597ddfd2ca Relicense under FDL 1.3 or later.
Glenn Morris <rgm@gnu.org>
parents: 98770
diff changeset
262 under the terms of the GNU Free Documentation License, Version 1.3 or
83955
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
263 any later version published by the Free Software Foundation; there
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
264 being no Invariant Section, with the Front-Cover Texts being ``A GNU
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
265 Manual'', and with the Back-Cover Texts as in (a) below. A copy of
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
266 the license is included in the section entitled ``GNU Free
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
267 Documentation License''.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
268
88088
985bbb7a574c emacs-lisp-intro.texi: Update back cover text.
Robert J. Chassell <bob@rattlesnake.com>
parents: 87649
diff changeset
269 (a) The FSF's Back-Cover Text is: ``You have the freedom to
985bbb7a574c emacs-lisp-intro.texi: Update back cover text.
Robert J. Chassell <bob@rattlesnake.com>
parents: 87649
diff changeset
270 copy and modify this GNU manual. Buying copies from the FSF
985bbb7a574c emacs-lisp-intro.texi: Update back cover text.
Robert J. Chassell <bob@rattlesnake.com>
parents: 87649
diff changeset
271 supports it in developing GNU and promoting software freedom.''
83955
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
272 @end copying
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
273
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
274 @c half title; two lines here, so do not use `shorttitlepage'
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
275 @tex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
276 {\begingroup%
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
277 \hbox{}\vskip 1.5in \chaprm \centerline{An Introduction to}%
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
278 \endgroup}%
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
279 {\begingroup\hbox{}\vskip 0.25in \chaprm%
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
280 \centerline{Programming in Emacs Lisp}%
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
281 \endgroup\page\hbox{}\page}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
282 @end tex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
283
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
284 @titlepage
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
285 @sp 6
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
286 @center @titlefont{An Introduction to}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
287 @sp 2
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
288 @center @titlefont{Programming in Emacs Lisp}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
289 @sp 2
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
290 @center Revised Third Edition
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
291 @sp 4
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
292 @center by Robert J. Chassell
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
293
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
294 @page
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
295 @vskip 0pt plus 1filll
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
296 @insertcopying
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
297 @end titlepage
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
298
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
299 @iftex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
300 @headings off
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
301 @evenheading @thispage @| @| @thischapter
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
302 @oddheading @thissection @| @| @thispage
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
303 @end iftex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
304
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
305 @ifnothtml
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
306 @c Keep T.O.C. short by tightening up for largebook
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
307 @ifset largebook
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
308 @tex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
309 \global\parskip 2pt plus 1pt
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
310 \global\advance\baselineskip by -1pt
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
311 @end tex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
312 @end ifset
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
313 @end ifnothtml
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
314
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
315 @shortcontents
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
316 @contents
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
317
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
318 @ifnottex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
319 @node Top, Preface, (dir), (dir)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
320 @top An Introduction to Programming in Emacs Lisp
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
321
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
322 @insertcopying
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
323
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
324 This master menu first lists each chapter and index; then it lists
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
325 every node in every chapter.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
326 @end ifnottex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
327
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
328 @c >>>> Set pageno appropriately <<<<
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
329
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
330 @c The first page of the Preface is a roman numeral; it is the first
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
331 @c right handed page after the Table of Contents; hence the following
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
332 @c setting must be for an odd negative number.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
333
98525
b6395ec3de45 formatting fixes for new printed edition
Karl Berry <karl@gnu.org>
parents: 94896
diff changeset
334 @c iftex
b6395ec3de45 formatting fixes for new printed edition
Karl Berry <karl@gnu.org>
parents: 94896
diff changeset
335 @c global@pageno = -11
b6395ec3de45 formatting fixes for new printed edition
Karl Berry <karl@gnu.org>
parents: 94896
diff changeset
336 @c end iftex
83955
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
337
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
338 @menu
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
339 * Preface:: What to look for.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
340 * List Processing:: What is Lisp?
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
341 * Practicing Evaluation:: Running several programs.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
342 * Writing Defuns:: How to write function definitions.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
343 * Buffer Walk Through:: Exploring a few buffer-related functions.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
344 * More Complex:: A few, even more complex functions.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
345 * Narrowing & Widening:: Restricting your and Emacs attention to
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
346 a region.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
347 * car cdr & cons:: Fundamental functions in Lisp.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
348 * Cutting & Storing Text:: Removing text and saving it.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
349 * List Implementation:: How lists are implemented in the computer.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
350 * Yanking:: Pasting stored text.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
351 * Loops & Recursion:: How to repeat a process.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
352 * Regexp Search:: Regular expression searches.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
353 * Counting Words:: A review of repetition and regexps.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
354 * Words in a defun:: Counting words in a @code{defun}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
355 * Readying a Graph:: A prototype graph printing function.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
356 * Emacs Initialization:: How to write a @file{.emacs} file.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
357 * Debugging:: How to run the Emacs Lisp debuggers.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
358 * Conclusion:: Now you have the basics.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
359 * the-the:: An appendix: how to find reduplicated words.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
360 * Kill Ring:: An appendix: how the kill ring works.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
361 * Full Graph:: How to create a graph with labelled axes.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
362 * Free Software and Free Manuals::
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
363 * GNU Free Documentation License::
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
364 * Index::
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
365 * About the Author::
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
366
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
367 @detailmenu
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
368 --- The Detailed Node Listing ---
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
369
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
370 Preface
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
371
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
372 * Why:: Why learn Emacs Lisp?
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
373 * On Reading this Text:: Read, gain familiarity, pick up habits....
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
374 * Who You Are:: For whom this is written.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
375 * Lisp History::
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
376 * Note for Novices:: You can read this as a novice.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
377 * Thank You::
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
378
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
379 List Processing
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
380
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
381 * Lisp Lists:: What are lists?
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
382 * Run a Program:: Any list in Lisp is a program ready to run.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
383 * Making Errors:: Generating an error message.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
384 * Names & Definitions:: Names of symbols and function definitions.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
385 * Lisp Interpreter:: What the Lisp interpreter does.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
386 * Evaluation:: Running a program.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
387 * Variables:: Returning a value from a variable.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
388 * Arguments:: Passing information to a function.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
389 * set & setq:: Setting the value of a variable.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
390 * Summary:: The major points.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
391 * Error Message Exercises::
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
392
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
393 Lisp Lists
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
394
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
395 * Numbers Lists:: List have numbers, other lists, in them.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
396 * Lisp Atoms:: Elemental entities.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
397 * Whitespace in Lists:: Formatting lists to be readable.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
398 * Typing Lists:: How GNU Emacs helps you type lists.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
399
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
400 The Lisp Interpreter
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
401
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
402 * Complications:: Variables, Special forms, Lists within.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
403 * Byte Compiling:: Specially processing code for speed.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
404
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
405 Evaluation
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
406
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
407 * How the Interpreter Acts:: Returns and Side Effects...
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
408 * Evaluating Inner Lists:: Lists within lists...
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
409
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
410 Variables
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
411
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
412 * fill-column Example::
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
413 * Void Function:: The error message for a symbol
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
414 without a function.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
415 * Void Variable:: The error message for a symbol without a value.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
416
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
417 Arguments
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
418
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
419 * Data types:: Types of data passed to a function.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
420 * Args as Variable or List:: An argument can be the value
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
421 of a variable or list.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
422 * Variable Number of Arguments:: Some functions may take a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
423 variable number of arguments.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
424 * Wrong Type of Argument:: Passing an argument of the wrong type
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
425 to a function.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
426 * message:: A useful function for sending messages.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
427
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
428 Setting the Value of a Variable
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
429
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
430 * Using set:: Setting values.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
431 * Using setq:: Setting a quoted value.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
432 * Counting:: Using @code{setq} to count.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
433
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
434 Practicing Evaluation
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
435
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
436 * How to Evaluate:: Typing editing commands or @kbd{C-x C-e}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
437 causes evaluation.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
438 * Buffer Names:: Buffers and files are different.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
439 * Getting Buffers:: Getting a buffer itself, not merely its name.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
440 * Switching Buffers:: How to change to another buffer.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
441 * Buffer Size & Locations:: Where point is located and the size of
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
442 the buffer.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
443 * Evaluation Exercise::
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
444
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
445 How To Write Function Definitions
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
446
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
447 * Primitive Functions::
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
448 * defun:: The @code{defun} special form.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
449 * Install:: Install a function definition.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
450 * Interactive:: Making a function interactive.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
451 * Interactive Options:: Different options for @code{interactive}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
452 * Permanent Installation:: Installing code permanently.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
453 * let:: Creating and initializing local variables.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
454 * if:: What if?
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
455 * else:: If--then--else expressions.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
456 * Truth & Falsehood:: What Lisp considers false and true.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
457 * save-excursion:: Keeping track of point, mark, and buffer.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
458 * Review::
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
459 * defun Exercises::
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
460
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
461 Install a Function Definition
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
462
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
463 * Effect of installation::
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
464 * Change a defun:: How to change a function definition.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
465
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
466 Make a Function Interactive
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
467
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
468 * Interactive multiply-by-seven:: An overview.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
469 * multiply-by-seven in detail:: The interactive version.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
470
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
471 @code{let}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
472
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
473 * Prevent confusion::
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
474 * Parts of let Expression::
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
475 * Sample let Expression::
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
476 * Uninitialized let Variables::
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
477
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
478 The @code{if} Special Form
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
479
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
480 * if in more detail::
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
481 * type-of-animal in detail:: An example of an @code{if} expression.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
482
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
483 Truth and Falsehood in Emacs Lisp
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
484
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
485 * nil explained:: @code{nil} has two meanings.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
486
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
487 @code{save-excursion}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
488
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
489 * Point and mark:: A review of various locations.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
490 * Template for save-excursion::
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
491
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
492 A Few Buffer--Related Functions
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
493
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
494 * Finding More:: How to find more information.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
495 * simplified-beginning-of-buffer:: Shows @code{goto-char},
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
496 @code{point-min}, and @code{push-mark}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
497 * mark-whole-buffer:: Almost the same as @code{beginning-of-buffer}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
498 * append-to-buffer:: Uses @code{save-excursion} and
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
499 @code{insert-buffer-substring}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
500 * Buffer Related Review:: Review.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
501 * Buffer Exercises::
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
502
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
503 The Definition of @code{mark-whole-buffer}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
504
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
505 * mark-whole-buffer overview::
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
506 * Body of mark-whole-buffer:: Only three lines of code.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
507
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
508 The Definition of @code{append-to-buffer}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
509
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
510 * append-to-buffer overview::
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
511 * append interactive:: A two part interactive expression.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
512 * append-to-buffer body:: Incorporates a @code{let} expression.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
513 * append save-excursion:: How the @code{save-excursion} works.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
514
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
515 A Few More Complex Functions
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
516
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
517 * copy-to-buffer:: With @code{set-buffer}, @code{get-buffer-create}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
518 * insert-buffer:: Read-only, and with @code{or}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
519 * beginning-of-buffer:: Shows @code{goto-char},
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
520 @code{point-min}, and @code{push-mark}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
521 * Second Buffer Related Review::
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
522 * optional Exercise::
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
523
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
524 The Definition of @code{insert-buffer}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
525
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
526 * insert-buffer code::
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
527 * insert-buffer interactive:: When you can read, but not write.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
528 * insert-buffer body:: The body has an @code{or} and a @code{let}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
529 * if & or:: Using an @code{if} instead of an @code{or}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
530 * Insert or:: How the @code{or} expression works.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
531 * Insert let:: Two @code{save-excursion} expressions.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
532 * New insert-buffer::
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
533
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
534 The Interactive Expression in @code{insert-buffer}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
535
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
536 * Read-only buffer:: When a buffer cannot be modified.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
537 * b for interactive:: An existing buffer or else its name.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
538
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
539 Complete Definition of @code{beginning-of-buffer}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
540
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
541 * Optional Arguments::
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
542 * beginning-of-buffer opt arg:: Example with optional argument.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
543 * beginning-of-buffer complete::
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
544
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
545 @code{beginning-of-buffer} with an Argument
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
546
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
547 * Disentangle beginning-of-buffer::
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
548 * Large buffer case::
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
549 * Small buffer case::
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
550
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
551 Narrowing and Widening
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
552
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
553 * Narrowing advantages:: The advantages of narrowing
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
554 * save-restriction:: The @code{save-restriction} special form.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
555 * what-line:: The number of the line that point is on.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
556 * narrow Exercise::
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
557
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
558 @code{car}, @code{cdr}, @code{cons}: Fundamental Functions
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
559
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
560 * Strange Names:: An historical aside: why the strange names?
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
561 * car & cdr:: Functions for extracting part of a list.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
562 * cons:: Constructing a list.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
563 * nthcdr:: Calling @code{cdr} repeatedly.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
564 * nth::
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
565 * setcar:: Changing the first element of a list.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
566 * setcdr:: Changing the rest of a list.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
567 * cons Exercise::
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
568
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
569 @code{cons}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
570
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
571 * Build a list::
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
572 * length:: How to find the length of a list.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
573
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
574 Cutting and Storing Text
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
575
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
576 * Storing Text:: Text is stored in a list.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
577 * zap-to-char:: Cutting out text up to a character.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
578 * kill-region:: Cutting text out of a region.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
579 * copy-region-as-kill:: A definition for copying text.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
580 * Digression into C:: Minor note on C programming language macros.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
581 * defvar:: How to give a variable an initial value.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
582 * cons & search-fwd Review::
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
583 * search Exercises::
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
584
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
585 @code{zap-to-char}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
586
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
587 * Complete zap-to-char:: The complete implementation.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
588 * zap-to-char interactive:: A three part interactive expression.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
589 * zap-to-char body:: A short overview.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
590 * search-forward:: How to search for a string.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
591 * progn:: The @code{progn} special form.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
592 * Summing up zap-to-char:: Using @code{point} and @code{search-forward}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
593
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
594 @code{kill-region}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
595
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
596 * Complete kill-region:: The function definition.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
597 * condition-case:: Dealing with a problem.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
598 * Lisp macro::
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
599
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
600 @code{copy-region-as-kill}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
601
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
602 * Complete copy-region-as-kill:: The complete function definition.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
603 * copy-region-as-kill body:: The body of @code{copy-region-as-kill}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
604
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
605 The Body of @code{copy-region-as-kill}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
606
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
607 * last-command & this-command::
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
608 * kill-append function::
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
609 * kill-new function::
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
610
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
611 Initializing a Variable with @code{defvar}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
612
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
613 * See variable current value::
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
614 * defvar and asterisk::
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
615
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
616 How Lists are Implemented
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
617
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
618 * Lists diagrammed::
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
619 * Symbols as Chest:: Exploring a powerful metaphor.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
620 * List Exercise::
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
621
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
622 Yanking Text Back
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
623
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
624 * Kill Ring Overview::
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
625 * kill-ring-yank-pointer:: The kill ring is a list.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
626 * yank nthcdr Exercises:: The @code{kill-ring-yank-pointer} variable.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
627
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
628 Loops and Recursion
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
629
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
630 * while:: Causing a stretch of code to repeat.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
631 * dolist dotimes::
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
632 * Recursion:: Causing a function to call itself.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
633 * Looping exercise::
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
634
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
635 @code{while}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
636
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
637 * Looping with while:: Repeat so long as test returns true.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
638 * Loop Example:: A @code{while} loop that uses a list.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
639 * print-elements-of-list:: Uses @code{while}, @code{car}, @code{cdr}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
640 * Incrementing Loop:: A loop with an incrementing counter.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
641 * Incrementing Loop Details::
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
642 * Decrementing Loop:: A loop with a decrementing counter.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
643
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
644 Details of an Incrementing Loop
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
645
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
646 * Incrementing Example:: Counting pebbles in a triangle.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
647 * Inc Example parts:: The parts of the function definition.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
648 * Inc Example altogether:: Putting the function definition together.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
649
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
650 Loop with a Decrementing Counter
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
651
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
652 * Decrementing Example:: More pebbles on the beach.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
653 * Dec Example parts:: The parts of the function definition.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
654 * Dec Example altogether:: Putting the function definition together.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
655
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
656 Save your time: @code{dolist} and @code{dotimes}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
657
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
658 * dolist::
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
659 * dotimes::
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
660
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
661 Recursion
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
662
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
663 * Building Robots:: Same model, different serial number ...
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
664 * Recursive Definition Parts:: Walk until you stop ...
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
665 * Recursion with list:: Using a list as the test whether to recurse.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
666 * Recursive triangle function::
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
667 * Recursion with cond::
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
668 * Recursive Patterns:: Often used templates.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
669 * No Deferment:: Don't store up work ...
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
670 * No deferment solution::
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
671
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
672 Recursion in Place of a Counter
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
673
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
674 * Recursive Example arg of 1 or 2::
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
675 * Recursive Example arg of 3 or 4::
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
676
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
677 Recursive Patterns
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
678
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
679 * Every::
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
680 * Accumulate::
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
681 * Keep::
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
682
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
683 Regular Expression Searches
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
684
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
685 * sentence-end:: The regular expression for @code{sentence-end}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
686 * re-search-forward:: Very similar to @code{search-forward}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
687 * forward-sentence:: A straightforward example of regexp search.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
688 * forward-paragraph:: A somewhat complex example.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
689 * etags:: How to create your own @file{TAGS} table.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
690 * Regexp Review::
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
691 * re-search Exercises::
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
692
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
693 @code{forward-sentence}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
694
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
695 * Complete forward-sentence::
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
696 * fwd-sentence while loops:: Two @code{while} loops.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
697 * fwd-sentence re-search:: A regular expression search.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
698
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
699 @code{forward-paragraph}: a Goldmine of Functions
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
700
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
701 * forward-paragraph in brief:: Key parts of the function definition.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
702 * fwd-para let:: The @code{let*} expression.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
703 * fwd-para while:: The forward motion @code{while} loop.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
704
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
705 Counting: Repetition and Regexps
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
706
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
707 * Why Count Words::
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
708 * count-words-region:: Use a regexp, but find a problem.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
709 * recursive-count-words:: Start with case of no words in region.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
710 * Counting Exercise::
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
711
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
712 The @code{count-words-region} Function
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
713
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
714 * Design count-words-region:: The definition using a @code{while} loop.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
715 * Whitespace Bug:: The Whitespace Bug in @code{count-words-region}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
716
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
717 Counting Words in a @code{defun}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
718
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
719 * Divide and Conquer::
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
720 * Words and Symbols:: What to count?
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
721 * Syntax:: What constitutes a word or symbol?
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
722 * count-words-in-defun:: Very like @code{count-words}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
723 * Several defuns:: Counting several defuns in a file.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
724 * Find a File:: Do you want to look at a file?
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
725 * lengths-list-file:: A list of the lengths of many definitions.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
726 * Several files:: Counting in definitions in different files.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
727 * Several files recursively:: Recursively counting in different files.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
728 * Prepare the data:: Prepare the data for display in a graph.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
729
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
730 Count Words in @code{defuns} in Different Files
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
731
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
732 * lengths-list-many-files:: Return a list of the lengths of defuns.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
733 * append:: Attach one list to another.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
734
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
735 Prepare the Data for Display in a Graph
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
736
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
737 * Data for Display in Detail::
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
738 * Sorting:: Sorting lists.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
739 * Files List:: Making a list of files.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
740 * Counting function definitions::
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
741
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
742 Readying a Graph
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
743
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
744 * Columns of a graph::
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
745 * graph-body-print:: How to print the body of a graph.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
746 * recursive-graph-body-print::
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
747 * Printed Axes::
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
748 * Line Graph Exercise::
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
749
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
750 Your @file{.emacs} File
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
751
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
752 * Default Configuration::
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
753 * Site-wide Init:: You can write site-wide init files.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
754 * defcustom:: Emacs will write code for you.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
755 * Beginning a .emacs File:: How to write a @code{.emacs file}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
756 * Text and Auto-fill:: Automatically wrap lines.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
757 * Mail Aliases:: Use abbreviations for email addresses.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
758 * Indent Tabs Mode:: Don't use tabs with @TeX{}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
759 * Keybindings:: Create some personal keybindings.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
760 * Keymaps:: More about key binding.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
761 * Loading Files:: Load (i.e., evaluate) files automatically.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
762 * Autoload:: Make functions available.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
763 * Simple Extension:: Define a function; bind it to a key.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
764 * X11 Colors:: Colors in X.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
765 * Miscellaneous::
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
766 * Mode Line:: How to customize your mode line.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
767
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
768 Debugging
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
769
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
770 * debug:: How to use the built-in debugger.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
771 * debug-on-entry:: Start debugging when you call a function.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
772 * debug-on-quit:: Start debugging when you quit with @kbd{C-g}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
773 * edebug:: How to use Edebug, a source level debugger.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
774 * Debugging Exercises::
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
775
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
776 Handling the Kill Ring
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
777
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
778 * What the Kill Ring Does::
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
779 * current-kill::
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
780 * yank:: Paste a copy of a clipped element.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
781 * yank-pop:: Insert element pointed to.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
782 * ring file::
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
783
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
784 The @code{current-kill} Function
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
785
103818
070d03e5b5e6 (Top): Add missing @detailmenu entry.
Glenn Morris <rgm@gnu.org>
parents: 103732
diff changeset
786 * Code for current-kill::
83955
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
787 * Understanding current-kill::
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
788
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
789 @code{current-kill} in Outline
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
790
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
791 * Body of current-kill::
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
792 * Digression concerning error:: How to mislead humans, but not computers.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
793 * Determining the Element::
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
794
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
795 A Graph with Labelled Axes
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
796
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
797 * Labelled Example::
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
798 * print-graph Varlist:: @code{let} expression in @code{print-graph}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
799 * print-Y-axis:: Print a label for the vertical axis.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
800 * print-X-axis:: Print a horizontal label.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
801 * Print Whole Graph:: The function to print a complete graph.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
802
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
803 The @code{print-Y-axis} Function
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
804
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
805 * print-Y-axis in Detail::
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
806 * Height of label:: What height for the Y axis?
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
807 * Compute a Remainder:: How to compute the remainder of a division.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
808 * Y Axis Element:: Construct a line for the Y axis.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
809 * Y-axis-column:: Generate a list of Y axis labels.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
810 * print-Y-axis Penultimate:: A not quite final version.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
811
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
812 The @code{print-X-axis} Function
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
813
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
814 * Similarities differences:: Much like @code{print-Y-axis}, but not exactly.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
815 * X Axis Tic Marks:: Create tic marks for the horizontal axis.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
816
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
817 Printing the Whole Graph
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
818
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
819 * The final version:: A few changes.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
820 * Test print-graph:: Run a short test.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
821 * Graphing words in defuns:: Executing the final code.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
822 * lambda:: How to write an anonymous function.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
823 * mapcar:: Apply a function to elements of a list.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
824 * Another Bug:: Yet another bug @dots{} most insidious.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
825 * Final printed graph:: The graph itself!
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
826
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
827 @end detailmenu
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
828 @end menu
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
829
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
830 @node Preface, List Processing, Top, Top
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
831 @comment node-name, next, previous, up
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
832 @unnumbered Preface
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
833
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
834 Most of the GNU Emacs integrated environment is written in the programming
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
835 language called Emacs Lisp. The code written in this programming
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
836 language is the software---the sets of instructions---that tell the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
837 computer what to do when you give it commands. Emacs is designed so
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
838 that you can write new code in Emacs Lisp and easily install it as an
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
839 extension to the editor.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
840
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
841 (GNU Emacs is sometimes called an ``extensible editor'', but it does
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
842 much more than provide editing capabilities. It is better to refer to
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
843 Emacs as an ``extensible computing environment''. However, that
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
844 phrase is quite a mouthful. It is easier to refer to Emacs simply as
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
845 an editor. Moreover, everything you do in Emacs---find the Mayan date
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
846 and phases of the moon, simplify polynomials, debug code, manage
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
847 files, read letters, write books---all these activities are kinds of
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
848 editing in the most general sense of the word.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
849
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
850 @menu
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
851 * Why:: Why learn Emacs Lisp?
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
852 * On Reading this Text:: Read, gain familiarity, pick up habits....
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
853 * Who You Are:: For whom this is written.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
854 * Lisp History::
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
855 * Note for Novices:: You can read this as a novice.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
856 * Thank You::
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
857 @end menu
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
858
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
859 @node Why, On Reading this Text, Preface, Preface
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
860 @ifnottex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
861 @unnumberedsec Why Study Emacs Lisp?
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
862 @end ifnottex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
863
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
864 Although Emacs Lisp is usually thought of in association only with Emacs,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
865 it is a full computer programming language. You can use Emacs Lisp as
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
866 you would any other programming language.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
867
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
868 Perhaps you want to understand programming; perhaps you want to extend
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
869 Emacs; or perhaps you want to become a programmer. This introduction to
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
870 Emacs Lisp is designed to get you started: to guide you in learning the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
871 fundamentals of programming, and more importantly, to show you how you
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
872 can teach yourself to go further.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
873
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
874 @node On Reading this Text, Who You Are, Why, Preface
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
875 @comment node-name, next, previous, up
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
876 @unnumberedsec On Reading this Text
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
877
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
878 All through this document, you will see little sample programs you can
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
879 run inside of Emacs. If you read this document in Info inside of GNU
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
880 Emacs, you can run the programs as they appear. (This is easy to do and
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
881 is explained when the examples are presented.) Alternatively, you can
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
882 read this introduction as a printed book while sitting beside a computer
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
883 running Emacs. (This is what I like to do; I like printed books.) If
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
884 you don't have a running Emacs beside you, you can still read this book,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
885 but in this case, it is best to treat it as a novel or as a travel guide
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
886 to a country not yet visited: interesting, but not the same as being
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
887 there.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
888
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
889 Much of this introduction is dedicated to walk-throughs or guided tours
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
890 of code used in GNU Emacs. These tours are designed for two purposes:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
891 first, to give you familiarity with real, working code (code you use
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
892 every day); and, second, to give you familiarity with the way Emacs
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
893 works. It is interesting to see how a working environment is
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
894 implemented.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
895 Also, I
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
896 hope that you will pick up the habit of browsing through source code.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
897 You can learn from it and mine it for ideas. Having GNU Emacs is like
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
898 having a dragon's cave of treasures.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
899
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
900 In addition to learning about Emacs as an editor and Emacs Lisp as a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
901 programming language, the examples and guided tours will give you an
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
902 opportunity to get acquainted with Emacs as a Lisp programming
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
903 environment. GNU Emacs supports programming and provides tools that
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
904 you will want to become comfortable using, such as @kbd{M-.} (the key
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
905 which invokes the @code{find-tag} command). You will also learn about
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
906 buffers and other objects that are part of the environment.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
907 Learning about these features of Emacs is like learning new routes
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
908 around your home town.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
909
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
910 @ignore
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
911 In addition, I have written several programs as extended examples.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
912 Although these are examples, the programs are real. I use them.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
913 Other people use them. You may use them. Beyond the fragments of
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
914 programs used for illustrations, there is very little in here that is
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
915 `just for teaching purposes'; what you see is used. This is a great
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
916 advantage of Emacs Lisp: it is easy to learn to use it for work.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
917 @end ignore
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
918
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
919 Finally, I hope to convey some of the skills for using Emacs to
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
920 learn aspects of programming that you don't know. You can often use
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
921 Emacs to help you understand what puzzles you or to find out how to do
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
922 something new. This self-reliance is not only a pleasure, but an
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
923 advantage.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
924
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
925 @node Who You Are, Lisp History, On Reading this Text, Preface
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
926 @comment node-name, next, previous, up
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
927 @unnumberedsec For Whom This is Written
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
928
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
929 This text is written as an elementary introduction for people who are
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
930 not programmers. If you are a programmer, you may not be satisfied with
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
931 this primer. The reason is that you may have become expert at reading
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
932 reference manuals and be put off by the way this text is organized.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
933
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
934 An expert programmer who reviewed this text said to me:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
935
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
936 @quotation
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
937 @i{I prefer to learn from reference manuals. I ``dive into'' each
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
938 paragraph, and ``come up for air'' between paragraphs.}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
939
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
940 @i{When I get to the end of a paragraph, I assume that that subject is
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
941 done, finished, that I know everything I need (with the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
942 possible exception of the case when the next paragraph starts talking
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
943 about it in more detail). I expect that a well written reference manual
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
944 will not have a lot of redundancy, and that it will have excellent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
945 pointers to the (one) place where the information I want is.}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
946 @end quotation
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
947
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
948 This introduction is not written for this person!
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
949
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
950 Firstly, I try to say everything at least three times: first, to
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
951 introduce it; second, to show it in context; and third, to show it in a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
952 different context, or to review it.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
953
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
954 Secondly, I hardly ever put all the information about a subject in one
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
955 place, much less in one paragraph. To my way of thinking, that imposes
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
956 too heavy a burden on the reader. Instead I try to explain only what
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
957 you need to know at the time. (Sometimes I include a little extra
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
958 information so you won't be surprised later when the additional
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
959 information is formally introduced.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
960
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
961 When you read this text, you are not expected to learn everything the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
962 first time. Frequently, you need only make, as it were, a `nodding
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
963 acquaintance' with some of the items mentioned. My hope is that I have
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
964 structured the text and given you enough hints that you will be alert to
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
965 what is important, and concentrate on it.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
966
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
967 You will need to ``dive into'' some paragraphs; there is no other way
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
968 to read them. But I have tried to keep down the number of such
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
969 paragraphs. This book is intended as an approachable hill, rather than
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
970 as a daunting mountain.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
971
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
972 This introduction to @cite{Programming in Emacs Lisp} has a companion
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
973 document,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
974 @iftex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
975 @cite{The GNU Emacs Lisp Reference Manual}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
976 @end iftex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
977 @ifnottex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
978 @ref{Top, , The GNU Emacs Lisp Reference Manual, elisp, The GNU
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
979 Emacs Lisp Reference Manual}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
980 @end ifnottex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
981 The reference manual has more detail than this introduction. In the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
982 reference manual, all the information about one topic is concentrated
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
983 in one place. You should turn to it if you are like the programmer
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
984 quoted above. And, of course, after you have read this
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
985 @cite{Introduction}, you will find the @cite{Reference Manual} useful
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
986 when you are writing your own programs.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
987
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
988 @node Lisp History, Note for Novices, Who You Are, Preface
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
989 @unnumberedsec Lisp History
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
990 @cindex Lisp history
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
991
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
992 Lisp was first developed in the late 1950s at the Massachusetts
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
993 Institute of Technology for research in artificial intelligence. The
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
994 great power of the Lisp language makes it superior for other purposes as
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
995 well, such as writing editor commands and integrated environments.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
996
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
997 @cindex Maclisp
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
998 @cindex Common Lisp
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
999 GNU Emacs Lisp is largely inspired by Maclisp, which was written at MIT
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1000 in the 1960s. It is somewhat inspired by Common Lisp, which became a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1001 standard in the 1980s. However, Emacs Lisp is much simpler than Common
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1002 Lisp. (The standard Emacs distribution contains an optional extensions
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1003 file, @file{cl.el}, that adds many Common Lisp features to Emacs Lisp.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1004
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1005 @node Note for Novices, Thank You, Lisp History, Preface
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1006 @comment node-name, next, previous, up
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1007 @unnumberedsec A Note for Novices
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1008
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1009 If you don't know GNU Emacs, you can still read this document
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1010 profitably. However, I recommend you learn Emacs, if only to learn to
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1011 move around your computer screen. You can teach yourself how to use
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1012 Emacs with the on-line tutorial. To use it, type @kbd{C-h t}. (This
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1013 means you press and release the @key{CTRL} key and the @kbd{h} at the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1014 same time, and then press and release @kbd{t}.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1015
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1016 Also, I often refer to one of Emacs' standard commands by listing the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1017 keys which you press to invoke the command and then giving the name of
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1018 the command in parentheses, like this: @kbd{M-C-\}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1019 (@code{indent-region}). What this means is that the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1020 @code{indent-region} command is customarily invoked by typing
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1021 @kbd{M-C-\}. (You can, if you wish, change the keys that are typed to
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1022 invoke the command; this is called @dfn{rebinding}. @xref{Keymaps, ,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1023 Keymaps}.) The abbreviation @kbd{M-C-\} means that you type your
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1024 @key{META} key, @key{CTRL} key and @key{\} key all at the same time.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1025 (On many modern keyboards the @key{META} key is labelled
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1026 @key{ALT}.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1027 Sometimes a combination like this is called a keychord, since it is
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1028 similar to the way you play a chord on a piano. If your keyboard does
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1029 not have a @key{META} key, the @key{ESC} key prefix is used in place
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1030 of it. In this case, @kbd{M-C-\} means that you press and release your
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1031 @key{ESC} key and then type the @key{CTRL} key and the @key{\} key at
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1032 the same time. But usually @kbd{M-C-\} means press the @key{CTRL} key
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1033 along with the key that is labelled @key{ALT} and, at the same time,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1034 press the @key{\} key.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1035
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1036 In addition to typing a lone keychord, you can prefix what you type
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1037 with @kbd{C-u}, which is called the `universal argument'. The
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1038 @kbd{C-u} keychord passes an argument to the subsequent command.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1039 Thus, to indent a region of plain text by 6 spaces, mark the region,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1040 and then type @w{@kbd{C-u 6 M-C-\}}. (If you do not specify a number,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1041 Emacs either passes the number 4 to the command or otherwise runs the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1042 command differently than it would otherwise.) @xref{Arguments, ,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1043 Numeric Arguments, emacs, The GNU Emacs Manual}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1044
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1045 If you are reading this in Info using GNU Emacs, you can read through
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1046 this whole document just by pressing the space bar, @key{SPC}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1047 (To learn about Info, type @kbd{C-h i} and then select Info.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1048
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1049 A note on terminology: when I use the word Lisp alone, I often am
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1050 referring to the various dialects of Lisp in general, but when I speak
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1051 of Emacs Lisp, I am referring to GNU Emacs Lisp in particular.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1052
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1053 @node Thank You, , Note for Novices, Preface
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1054 @comment node-name, next, previous, up
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1055 @unnumberedsec Thank You
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1056
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1057 My thanks to all who helped me with this book. My especial thanks to
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1058 @r{Jim Blandy}, @r{Noah Friedman}, @w{Jim Kingdon}, @r{Roland
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1059 McGrath}, @w{Frank Ritter}, @w{Randy Smith}, @w{Richard M.@:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1060 Stallman}, and @w{Melissa Weisshaus}. My thanks also go to both
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1061 @w{Philip Johnson} and @w{David Stampe} for their patient
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1062 encouragement. My mistakes are my own.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1063
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1064 @flushright
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1065 Robert J. Chassell
84515
6979ff5651fe Add email address to Thank You correctly
Robert J. Chassell <bob@rattlesnake.com>
parents: 84513
diff changeset
1066 @email{bob@@gnu.org}
83955
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1067 @end flushright
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1068
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1069 @c ================ Beginning of main text ================
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1070
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1071 @c Start main text on right-hand (verso) page
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1072
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1073 @tex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1074 \par\vfill\supereject
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1075 \headings off
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1076 \ifodd\pageno
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1077 \par\vfill\supereject
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1078 \else
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1079 \par\vfill\supereject
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1080 \page\hbox{}\page
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1081 \par\vfill\supereject
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1082 \fi
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1083 @end tex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1084
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1085 @iftex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1086 @headings off
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1087 @evenheading @thispage @| @| @thischapter
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1088 @oddheading @thissection @| @| @thispage
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1089 @global@pageno = 1
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1090 @end iftex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1091
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1092 @node List Processing, Practicing Evaluation, Preface, Top
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1093 @comment node-name, next, previous, up
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1094 @chapter List Processing
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1095
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1096 To the untutored eye, Lisp is a strange programming language. In Lisp
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1097 code there are parentheses everywhere. Some people even claim that
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1098 the name stands for `Lots of Isolated Silly Parentheses'. But the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1099 claim is unwarranted. Lisp stands for LISt Processing, and the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1100 programming language handles @emph{lists} (and lists of lists) by
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1101 putting them between parentheses. The parentheses mark the boundaries
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1102 of the list. Sometimes a list is preceded by a single apostrophe or
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1103 quotation mark, @samp{'}@footnote{The single apostrophe or quotation
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1104 mark is an abbreviation for the function @code{quote}; you need not
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1105 think about functions now; functions are defined in @ref{Making
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1106 Errors, , Generate an Error Message}.} Lists are the basis of Lisp.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1107
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1108 @menu
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1109 * Lisp Lists:: What are lists?
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1110 * Run a Program:: Any list in Lisp is a program ready to run.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1111 * Making Errors:: Generating an error message.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1112 * Names & Definitions:: Names of symbols and function definitions.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1113 * Lisp Interpreter:: What the Lisp interpreter does.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1114 * Evaluation:: Running a program.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1115 * Variables:: Returning a value from a variable.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1116 * Arguments:: Passing information to a function.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1117 * set & setq:: Setting the value of a variable.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1118 * Summary:: The major points.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1119 * Error Message Exercises::
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1120 @end menu
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1121
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1122 @node Lisp Lists, Run a Program, List Processing, List Processing
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1123 @comment node-name, next, previous, up
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1124 @section Lisp Lists
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1125 @cindex Lisp Lists
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1126
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1127 In Lisp, a list looks like this: @code{'(rose violet daisy buttercup)}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1128 This list is preceded by a single apostrophe. It could just as well be
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1129 written as follows, which looks more like the kind of list you are likely
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1130 to be familiar with:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1131
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1132 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1133 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1134 '(rose
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1135 violet
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1136 daisy
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1137 buttercup)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1138 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1139 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1140
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1141 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1142 The elements of this list are the names of the four different flowers,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1143 separated from each other by whitespace and surrounded by parentheses,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1144 like flowers in a field with a stone wall around them.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1145 @cindex Flowers in a field
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1146
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1147 @menu
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1148 * Numbers Lists:: List have numbers, other lists, in them.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1149 * Lisp Atoms:: Elemental entities.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1150 * Whitespace in Lists:: Formatting lists to be readable.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1151 * Typing Lists:: How GNU Emacs helps you type lists.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1152 @end menu
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1153
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1154 @node Numbers Lists, Lisp Atoms, Lisp Lists, Lisp Lists
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1155 @ifnottex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1156 @unnumberedsubsec Numbers, Lists inside of Lists
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1157 @end ifnottex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1158
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1159 Lists can also have numbers in them, as in this list: @code{(+ 2 2)}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1160 This list has a plus-sign, @samp{+}, followed by two @samp{2}s, each
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1161 separated by whitespace.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1162
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1163 In Lisp, both data and programs are represented the same way; that is,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1164 they are both lists of words, numbers, or other lists, separated by
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1165 whitespace and surrounded by parentheses. (Since a program looks like
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1166 data, one program may easily serve as data for another; this is a very
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1167 powerful feature of Lisp.) (Incidentally, these two parenthetical
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1168 remarks are @emph{not} Lisp lists, because they contain @samp{;} and
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1169 @samp{.} as punctuation marks.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1170
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1171 @need 1200
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1172 Here is another list, this time with a list inside of it:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1173
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1174 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1175 '(this list has (a list inside of it))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1176 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1177
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1178 The components of this list are the words @samp{this}, @samp{list},
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1179 @samp{has}, and the list @samp{(a list inside of it)}. The interior
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1180 list is made up of the words @samp{a}, @samp{list}, @samp{inside},
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1181 @samp{of}, @samp{it}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1182
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1183 @node Lisp Atoms, Whitespace in Lists, Numbers Lists, Lisp Lists
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1184 @comment node-name, next, previous, up
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1185 @subsection Lisp Atoms
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1186 @cindex Lisp Atoms
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1187
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1188 In Lisp, what we have been calling words are called @dfn{atoms}. This
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1189 term comes from the historical meaning of the word atom, which means
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1190 `indivisible'. As far as Lisp is concerned, the words we have been
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1191 using in the lists cannot be divided into any smaller parts and still
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1192 mean the same thing as part of a program; likewise with numbers and
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1193 single character symbols like @samp{+}. On the other hand, unlike an
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1194 ancient atom, a list can be split into parts. (@xref{car cdr & cons,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1195 , @code{car} @code{cdr} & @code{cons} Fundamental Functions}.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1196
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1197 In a list, atoms are separated from each other by whitespace. They can be
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1198 right next to a parenthesis.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1199
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1200 @cindex @samp{empty list} defined
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1201 Technically speaking, a list in Lisp consists of parentheses surrounding
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1202 atoms separated by whitespace or surrounding other lists or surrounding
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1203 both atoms and other lists. A list can have just one atom in it or
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1204 have nothing in it at all. A list with nothing in it looks like this:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1205 @code{()}, and is called the @dfn{empty list}. Unlike anything else, an
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1206 empty list is considered both an atom and a list at the same time.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1207
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1208 @cindex Symbolic expressions, introduced
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1209 @cindex @samp{expression} defined
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1210 @cindex @samp{form} defined
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1211 The printed representation of both atoms and lists are called
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1212 @dfn{symbolic expressions} or, more concisely, @dfn{s-expressions}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1213 The word @dfn{expression} by itself can refer to either the printed
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1214 representation, or to the atom or list as it is held internally in the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1215 computer. Often, people use the term @dfn{expression}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1216 indiscriminately. (Also, in many texts, the word @dfn{form} is used
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1217 as a synonym for expression.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1218
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1219 Incidentally, the atoms that make up our universe were named such when
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1220 they were thought to be indivisible; but it has been found that physical
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1221 atoms are not indivisible. Parts can split off an atom or it can
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1222 fission into two parts of roughly equal size. Physical atoms were named
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1223 prematurely, before their truer nature was found. In Lisp, certain
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1224 kinds of atom, such as an array, can be separated into parts; but the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1225 mechanism for doing this is different from the mechanism for splitting a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1226 list. As far as list operations are concerned, the atoms of a list are
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1227 unsplittable.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1228
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1229 As in English, the meanings of the component letters of a Lisp atom
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1230 are different from the meaning the letters make as a word. For
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1231 example, the word for the South American sloth, the @samp{ai}, is
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1232 completely different from the two words, @samp{a}, and @samp{i}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1233
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1234 There are many kinds of atom in nature but only a few in Lisp: for
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1235 example, @dfn{numbers}, such as 37, 511, or 1729, and @dfn{symbols}, such
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1236 as @samp{+}, @samp{foo}, or @samp{forward-line}. The words we have
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1237 listed in the examples above are all symbols. In everyday Lisp
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1238 conversation, the word ``atom'' is not often used, because programmers
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1239 usually try to be more specific about what kind of atom they are dealing
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1240 with. Lisp programming is mostly about symbols (and sometimes numbers)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1241 within lists. (Incidentally, the preceding three word parenthetical
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1242 remark is a proper list in Lisp, since it consists of atoms, which in
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1243 this case are symbols, separated by whitespace and enclosed by
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1244 parentheses, without any non-Lisp punctuation.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1245
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1246 @need 1250
94896
3c3a05682534 (Lisp Atoms): Rephrase "in addition" to avoid confusion with addition
Chong Yidong <cyd@stupidchicken.com>
parents: 94188
diff changeset
1247 Text between double quotation marks---even sentences or
3c3a05682534 (Lisp Atoms): Rephrase "in addition" to avoid confusion with addition
Chong Yidong <cyd@stupidchicken.com>
parents: 94188
diff changeset
1248 paragraphs---is also an atom. Here is an example:
83955
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1249 @cindex Text between double quotation marks
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1250
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1251 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1252 '(this list includes "text between quotation marks.")
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1253 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1254
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1255 @cindex @samp{string} defined
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1256 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1257 In Lisp, all of the quoted text including the punctuation mark and the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1258 blank spaces is a single atom. This kind of atom is called a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1259 @dfn{string} (for `string of characters') and is the sort of thing that
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1260 is used for messages that a computer can print for a human to read.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1261 Strings are a different kind of atom than numbers or symbols and are
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1262 used differently.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1263
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1264 @node Whitespace in Lists, Typing Lists, Lisp Atoms, Lisp Lists
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1265 @comment node-name, next, previous, up
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1266 @subsection Whitespace in Lists
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1267 @cindex Whitespace in lists
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1268
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1269 @need 1200
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1270 The amount of whitespace in a list does not matter. From the point of view
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1271 of the Lisp language,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1272
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1273 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1274 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1275 '(this list
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1276 looks like this)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1277 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1278 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1279
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1280 @need 800
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1281 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1282 is exactly the same as this:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1283
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1284 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1285 '(this list looks like this)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1286 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1287
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1288 Both examples show what to Lisp is the same list, the list made up of
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1289 the symbols @samp{this}, @samp{list}, @samp{looks}, @samp{like}, and
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1290 @samp{this} in that order.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1291
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1292 Extra whitespace and newlines are designed to make a list more readable
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1293 by humans. When Lisp reads the expression, it gets rid of all the extra
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1294 whitespace (but it needs to have at least one space between atoms in
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1295 order to tell them apart.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1296
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1297 Odd as it seems, the examples we have seen cover almost all of what Lisp
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1298 lists look like! Every other list in Lisp looks more or less like one
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1299 of these examples, except that the list may be longer and more complex.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1300 In brief, a list is between parentheses, a string is between quotation
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1301 marks, a symbol looks like a word, and a number looks like a number.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1302 (For certain situations, square brackets, dots and a few other special
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1303 characters may be used; however, we will go quite far without them.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1304
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1305 @node Typing Lists, , Whitespace in Lists, Lisp Lists
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1306 @comment node-name, next, previous, up
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1307 @subsection GNU Emacs Helps You Type Lists
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1308 @cindex Help typing lists
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1309 @cindex Formatting help
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1310
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1311 When you type a Lisp expression in GNU Emacs using either Lisp
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1312 Interaction mode or Emacs Lisp mode, you have available to you several
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1313 commands to format the Lisp expression so it is easy to read. For
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1314 example, pressing the @key{TAB} key automatically indents the line the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1315 cursor is on by the right amount. A command to properly indent the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1316 code in a region is customarily bound to @kbd{M-C-\}. Indentation is
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1317 designed so that you can see which elements of a list belong to which
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1318 list---elements of a sub-list are indented more than the elements of
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1319 the enclosing list.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1320
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1321 In addition, when you type a closing parenthesis, Emacs momentarily
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1322 jumps the cursor back to the matching opening parenthesis, so you can
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1323 see which one it is. This is very useful, since every list you type
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1324 in Lisp must have its closing parenthesis match its opening
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1325 parenthesis. (@xref{Major Modes, , Major Modes, emacs, The GNU Emacs
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1326 Manual}, for more information about Emacs' modes.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1327
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1328 @node Run a Program, Making Errors, Lisp Lists, List Processing
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1329 @comment node-name, next, previous, up
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1330 @section Run a Program
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1331 @cindex Run a program
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1332 @cindex Program, running one
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1333
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1334 @cindex @samp{evaluate} defined
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1335 A list in Lisp---any list---is a program ready to run. If you run it
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1336 (for which the Lisp jargon is @dfn{evaluate}), the computer will do one
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1337 of three things: do nothing except return to you the list itself; send
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1338 you an error message; or, treat the first symbol in the list as a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1339 command to do something. (Usually, of course, it is the last of these
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1340 three things that you really want!)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1341
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1342 @c use code for the single apostrophe, not samp.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1343 The single apostrophe, @code{'}, that I put in front of some of the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1344 example lists in preceding sections is called a @dfn{quote}; when it
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1345 precedes a list, it tells Lisp to do nothing with the list, other than
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1346 take it as it is written. But if there is no quote preceding a list,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1347 the first item of the list is special: it is a command for the computer
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1348 to obey. (In Lisp, these commands are called @emph{functions}.) The list
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1349 @code{(+ 2 2)} shown above did not have a quote in front of it, so Lisp
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1350 understands that the @code{+} is an instruction to do something with the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1351 rest of the list: add the numbers that follow.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1352
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1353 @need 1250
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1354 If you are reading this inside of GNU Emacs in Info, here is how you can
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1355 evaluate such a list: place your cursor immediately after the right
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1356 hand parenthesis of the following list and then type @kbd{C-x C-e}:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1357
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1358 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1359 (+ 2 2)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1360 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1361
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1362 @c use code for the number four, not samp.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1363 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1364 You will see the number @code{4} appear in the echo area. (In the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1365 jargon, what you have just done is ``evaluate the list.'' The echo area
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1366 is the line at the bottom of the screen that displays or ``echoes''
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1367 text.) Now try the same thing with a quoted list: place the cursor
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1368 right after the following list and type @kbd{C-x C-e}:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1369
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1370 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1371 '(this is a quoted list)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1372 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1373
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1374 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1375 You will see @code{(this is a quoted list)} appear in the echo area.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1376
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1377 @cindex Lisp interpreter, explained
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1378 @cindex Interpreter, Lisp, explained
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1379 In both cases, what you are doing is giving a command to the program
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1380 inside of GNU Emacs called the @dfn{Lisp interpreter}---giving the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1381 interpreter a command to evaluate the expression. The name of the Lisp
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1382 interpreter comes from the word for the task done by a human who comes
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1383 up with the meaning of an expression---who ``interprets'' it.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1384
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1385 You can also evaluate an atom that is not part of a list---one that is
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1386 not surrounded by parentheses; again, the Lisp interpreter translates
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1387 from the humanly readable expression to the language of the computer.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1388 But before discussing this (@pxref{Variables}), we will discuss what the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1389 Lisp interpreter does when you make an error.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1390
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1391 @node Making Errors, Names & Definitions, Run a Program, List Processing
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1392 @comment node-name, next, previous, up
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1393 @section Generate an Error Message
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1394 @cindex Generate an error message
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1395 @cindex Error message generation
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1396
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1397 Partly so you won't worry if you do it accidentally, we will now give
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1398 a command to the Lisp interpreter that generates an error message.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1399 This is a harmless activity; and indeed, we will often try to generate
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1400 error messages intentionally. Once you understand the jargon, error
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1401 messages can be informative. Instead of being called ``error''
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1402 messages, they should be called ``help'' messages. They are like
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1403 signposts to a traveller in a strange country; deciphering them can be
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1404 hard, but once understood, they can point the way.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1405
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1406 The error message is generated by a built-in GNU Emacs debugger. We
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1407 will `enter the debugger'. You get out of the debugger by typing @code{q}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1408
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1409 What we will do is evaluate a list that is not quoted and does not
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1410 have a meaningful command as its first element. Here is a list almost
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1411 exactly the same as the one we just used, but without the single-quote
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1412 in front of it. Position the cursor right after it and type @kbd{C-x
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1413 C-e}:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1414
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1415 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1416 (this is an unquoted list)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1417 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1418
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1419 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1420 What you see depends on which version of Emacs you are running. GNU
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1421 Emacs version 22 provides more information than version 20 and before.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1422 First, the more recent result of generating an error; then the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1423 earlier, version 20 result.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1424
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1425 @need 1250
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1426 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1427 In GNU Emacs version 22, a @file{*Backtrace*} window will open up and
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1428 you will see the following in it:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1429
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1430 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1431 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1432 ---------- Buffer: *Backtrace* ----------
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1433 Debugger entered--Lisp error: (void-function this)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1434 (this is an unquoted list)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1435 eval((this is an unquoted list))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1436 eval-last-sexp-1(nil)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1437 eval-last-sexp(nil)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1438 call-interactively(eval-last-sexp)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1439 ---------- Buffer: *Backtrace* ----------
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1440 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1441 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1442
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1443 @need 1200
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1444 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1445 Your cursor will be in this window (you may have to wait a few seconds
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1446 before it becomes visible). To quit the debugger and make the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1447 debugger window go away, type:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1448
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1449 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1450 q
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1451 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1452
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1453 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1454 Please type @kbd{q} right now, so you become confident that you can
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1455 get out of the debugger. Then, type @kbd{C-x C-e} again to re-enter
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1456 it.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1457
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1458 @cindex @samp{function} defined
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1459 Based on what we already know, we can almost read this error message.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1460
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1461 You read the @file{*Backtrace*} buffer from the bottom up; it tells
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1462 you what Emacs did. When you typed @kbd{C-x C-e}, you made an
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1463 interactive call to the command @code{eval-last-sexp}. @code{eval} is
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1464 an abbreviation for `evaluate' and @code{sexp} is an abbreviation for
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1465 `symbolic expression'. The command means `evaluate last symbolic
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1466 expression', which is the expression just before your cursor.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1467
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1468 Each line above tells you what the Lisp interpreter evaluated next.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1469 The most recent action is at the top. The buffer is called the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1470 @file{*Backtrace*} buffer because it enables you to track Emacs
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1471 backwards.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1472
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1473 @need 800
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1474 At the top of the @file{*Backtrace*} buffer, you see the line:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1475
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1476 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1477 Debugger entered--Lisp error: (void-function this)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1478 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1479
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1480 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1481 The Lisp interpreter tried to evaluate the first atom of the list, the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1482 word @samp{this}. It is this action that generated the error message
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1483 @samp{void-function this}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1484
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1485 The message contains the words @samp{void-function} and @samp{this}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1486
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1487 @cindex @samp{function} defined
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1488 The word @samp{function} was mentioned once before. It is a very
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1489 important word. For our purposes, we can define it by saying that a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1490 @dfn{function} is a set of instructions to the computer that tell the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1491 computer to do something.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1492
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1493 Now we can begin to understand the error message: @samp{void-function
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1494 this}. The function (that is, the word @samp{this}) does not have a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1495 definition of any set of instructions for the computer to carry out.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1496
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1497 The slightly odd word, @samp{void-function}, is designed to cover the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1498 way Emacs Lisp is implemented, which is that when a symbol does not
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1499 have a function definition attached to it, the place that should
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1500 contain the instructions is `void'.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1501
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1502 On the other hand, since we were able to add 2 plus 2 successfully, by
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1503 evaluating @code{(+ 2 2)}, we can infer that the symbol @code{+} must
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1504 have a set of instructions for the computer to obey and those
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1505 instructions must be to add the numbers that follow the @code{+}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1506
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1507 @need 1250
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1508 In GNU Emacs version 20, and in earlier versions, you will see only
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1509 one line of error message; it will appear in the echo area and look
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1510 like this:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1511
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1512 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1513 Symbol's function definition is void:@: this
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1514 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1515
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1516 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1517 (Also, your terminal may beep at you---some do, some don't; and others
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1518 blink. This is just a device to get your attention.) The message goes
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1519 away as soon as you type another key, even just to move the cursor.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1520
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1521 We know the meaning of the word @samp{Symbol}. It refers to the first
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1522 atom of the list, the word @samp{this}. The word @samp{function}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1523 refers to the instructions that tell the computer what to do.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1524 (Technically, the symbol tells the computer where to find the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1525 instructions, but this is a complication we can ignore for the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1526 moment.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1527
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1528 The error message can be understood: @samp{Symbol's function
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1529 definition is void:@: this}. The symbol (that is, the word
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1530 @samp{this}) lacks instructions for the computer to carry out.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1531
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1532 @node Names & Definitions, Lisp Interpreter, Making Errors, List Processing
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1533 @comment node-name, next, previous, up
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1534 @section Symbol Names and Function Definitions
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1535 @cindex Symbol names
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1536
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1537 We can articulate another characteristic of Lisp based on what we have
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1538 discussed so far---an important characteristic: a symbol, like
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1539 @code{+}, is not itself the set of instructions for the computer to
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1540 carry out. Instead, the symbol is used, perhaps temporarily, as a way
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1541 of locating the definition or set of instructions. What we see is the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1542 name through which the instructions can be found. Names of people
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1543 work the same way. I can be referred to as @samp{Bob}; however, I am
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1544 not the letters @samp{B}, @samp{o}, @samp{b} but am, or was, the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1545 consciousness consistently associated with a particular life-form.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1546 The name is not me, but it can be used to refer to me.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1547
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1548 In Lisp, one set of instructions can be attached to several names.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1549 For example, the computer instructions for adding numbers can be
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1550 linked to the symbol @code{plus} as well as to the symbol @code{+}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1551 (and are in some dialects of Lisp). Among humans, I can be referred
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1552 to as @samp{Robert} as well as @samp{Bob} and by other words as well.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1553
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1554 On the other hand, a symbol can have only one function definition
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1555 attached to it at a time. Otherwise, the computer would be confused as
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1556 to which definition to use. If this were the case among people, only
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1557 one person in the world could be named @samp{Bob}. However, the function
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1558 definition to which the name refers can be changed readily.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1559 (@xref{Install, , Install a Function Definition}.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1560
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1561 Since Emacs Lisp is large, it is customary to name symbols in a way
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1562 that identifies the part of Emacs to which the function belongs.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1563 Thus, all the names for functions that deal with Texinfo start with
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1564 @samp{texinfo-} and those for functions that deal with reading mail
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1565 start with @samp{rmail-}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1566
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1567 @node Lisp Interpreter, Evaluation, Names & Definitions, List Processing
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1568 @comment node-name, next, previous, up
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1569 @section The Lisp Interpreter
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1570 @cindex Lisp interpreter, what it does
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1571 @cindex Interpreter, what it does
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1572
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1573 Based on what we have seen, we can now start to figure out what the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1574 Lisp interpreter does when we command it to evaluate a list.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1575 First, it looks to see whether there is a quote before the list; if
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1576 there is, the interpreter just gives us the list. On the other
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1577 hand, if there is no quote, the interpreter looks at the first element
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1578 in the list and sees whether it has a function definition. If it does,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1579 the interpreter carries out the instructions in the function definition.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1580 Otherwise, the interpreter prints an error message.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1581
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1582 This is how Lisp works. Simple. There are added complications which we
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1583 will get to in a minute, but these are the fundamentals. Of course, to
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1584 write Lisp programs, you need to know how to write function definitions
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1585 and attach them to names, and how to do this without confusing either
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1586 yourself or the computer.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1587
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1588 @menu
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1589 * Complications:: Variables, Special forms, Lists within.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1590 * Byte Compiling:: Specially processing code for speed.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1591 @end menu
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1592
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1593 @node Complications, Byte Compiling, Lisp Interpreter, Lisp Interpreter
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1594 @ifnottex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1595 @unnumberedsubsec Complications
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1596 @end ifnottex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1597
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1598 Now, for the first complication. In addition to lists, the Lisp
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1599 interpreter can evaluate a symbol that is not quoted and does not have
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1600 parentheses around it. The Lisp interpreter will attempt to determine
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1601 the symbol's value as a @dfn{variable}. This situation is described
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1602 in the section on variables. (@xref{Variables}.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1603
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1604 @cindex Special form
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1605 The second complication occurs because some functions are unusual and do
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1606 not work in the usual manner. Those that don't are called @dfn{special
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1607 forms}. They are used for special jobs, like defining a function, and
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1608 there are not many of them. In the next few chapters, you will be
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1609 introduced to several of the more important special forms.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1610
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1611 The third and final complication is this: if the function that the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1612 Lisp interpreter is looking at is not a special form, and if it is part
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1613 of a list, the Lisp interpreter looks to see whether the list has a list
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1614 inside of it. If there is an inner list, the Lisp interpreter first
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1615 figures out what it should do with the inside list, and then it works on
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1616 the outside list. If there is yet another list embedded inside the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1617 inner list, it works on that one first, and so on. It always works on
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1618 the innermost list first. The interpreter works on the innermost list
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1619 first, to evaluate the result of that list. The result may be
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1620 used by the enclosing expression.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1621
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1622 Otherwise, the interpreter works left to right, from one expression to
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1623 the next.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1624
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1625 @node Byte Compiling, , Complications, Lisp Interpreter
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1626 @subsection Byte Compiling
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1627 @cindex Byte compiling
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1628
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1629 One other aspect of interpreting: the Lisp interpreter is able to
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1630 interpret two kinds of entity: humanly readable code, on which we will
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1631 focus exclusively, and specially processed code, called @dfn{byte
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1632 compiled} code, which is not humanly readable. Byte compiled code
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1633 runs faster than humanly readable code.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1634
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1635 You can transform humanly readable code into byte compiled code by
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1636 running one of the compile commands such as @code{byte-compile-file}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1637 Byte compiled code is usually stored in a file that ends with a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1638 @file{.elc} extension rather than a @file{.el} extension. You will
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1639 see both kinds of file in the @file{emacs/lisp} directory; the files
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1640 to read are those with @file{.el} extensions.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1641
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1642 As a practical matter, for most things you might do to customize or
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1643 extend Emacs, you do not need to byte compile; and I will not discuss
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1644 the topic here. @xref{Byte Compilation, , Byte Compilation, elisp,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1645 The GNU Emacs Lisp Reference Manual}, for a full description of byte
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1646 compilation.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1647
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1648 @node Evaluation, Variables, Lisp Interpreter, List Processing
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1649 @comment node-name, next, previous, up
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1650 @section Evaluation
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1651 @cindex Evaluation
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1652
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1653 When the Lisp interpreter works on an expression, the term for the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1654 activity is called @dfn{evaluation}. We say that the interpreter
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1655 `evaluates the expression'. I've used this term several times before.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1656 The word comes from its use in everyday language, `to ascertain the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1657 value or amount of; to appraise', according to @cite{Webster's New
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1658 Collegiate Dictionary}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1659
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1660 @menu
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1661 * How the Interpreter Acts:: Returns and Side Effects...
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1662 * Evaluating Inner Lists:: Lists within lists...
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1663 @end menu
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1664
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1665 @node How the Interpreter Acts, Evaluating Inner Lists, Evaluation, Evaluation
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1666 @ifnottex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1667 @unnumberedsubsec How the Lisp Interpreter Acts
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1668 @end ifnottex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1669
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1670 @cindex @samp{returned value} explained
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1671 After evaluating an expression, the Lisp interpreter will most likely
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1672 @dfn{return} the value that the computer produces by carrying out the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1673 instructions it found in the function definition, or perhaps it will
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1674 give up on that function and produce an error message. (The interpreter
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1675 may also find itself tossed, so to speak, to a different function or it
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1676 may attempt to repeat continually what it is doing for ever and ever in
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1677 what is called an `infinite loop'. These actions are less common; and
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1678 we can ignore them.) Most frequently, the interpreter returns a value.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1679
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1680 @cindex @samp{side effect} defined
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1681 At the same time the interpreter returns a value, it may do something
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1682 else as well, such as move a cursor or copy a file; this other kind of
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1683 action is called a @dfn{side effect}. Actions that we humans think are
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1684 important, such as printing results, are often ``side effects'' to the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1685 Lisp interpreter. The jargon can sound peculiar, but it turns out that
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1686 it is fairly easy to learn to use side effects.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1687
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1688 In summary, evaluating a symbolic expression most commonly causes the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1689 Lisp interpreter to return a value and perhaps carry out a side effect;
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1690 or else produce an error.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1691
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1692 @node Evaluating Inner Lists, , How the Interpreter Acts, Evaluation
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1693 @comment node-name, next, previous, up
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1694 @subsection Evaluating Inner Lists
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1695 @cindex Inner list evaluation
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1696 @cindex Evaluating inner lists
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1697
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1698 If evaluation applies to a list that is inside another list, the outer
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1699 list may use the value returned by the first evaluation as information
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1700 when the outer list is evaluated. This explains why inner expressions
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1701 are evaluated first: the values they return are used by the outer
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1702 expressions.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1703
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1704 @need 1250
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1705 We can investigate this process by evaluating another addition example.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1706 Place your cursor after the following expression and type @kbd{C-x C-e}:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1707
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1708 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1709 (+ 2 (+ 3 3))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1710 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1711
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1712 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1713 The number 8 will appear in the echo area.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1714
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1715 What happens is that the Lisp interpreter first evaluates the inner
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1716 expression, @code{(+ 3 3)}, for which the value 6 is returned; then it
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1717 evaluates the outer expression as if it were written @code{(+ 2 6)}, which
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1718 returns the value 8. Since there are no more enclosing expressions to
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1719 evaluate, the interpreter prints that value in the echo area.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1720
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1721 Now it is easy to understand the name of the command invoked by the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1722 keystrokes @kbd{C-x C-e}: the name is @code{eval-last-sexp}. The
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1723 letters @code{sexp} are an abbreviation for `symbolic expression', and
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1724 @code{eval} is an abbreviation for `evaluate'. The command means
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1725 `evaluate last symbolic expression'.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1726
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1727 As an experiment, you can try evaluating the expression by putting the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1728 cursor at the beginning of the next line immediately following the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1729 expression, or inside the expression.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1730
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1731 @need 800
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1732 Here is another copy of the expression:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1733
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1734 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1735 (+ 2 (+ 3 3))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1736 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1737
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1738 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1739 If you place the cursor at the beginning of the blank line that
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1740 immediately follows the expression and type @kbd{C-x C-e}, you will
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1741 still get the value 8 printed in the echo area. Now try putting the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1742 cursor inside the expression. If you put it right after the next to
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1743 last parenthesis (so it appears to sit on top of the last parenthesis),
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1744 you will get a 6 printed in the echo area! This is because the command
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1745 evaluates the expression @code{(+ 3 3)}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1746
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1747 Now put the cursor immediately after a number. Type @kbd{C-x C-e} and
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1748 you will get the number itself. In Lisp, if you evaluate a number, you
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1749 get the number itself---this is how numbers differ from symbols. If you
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1750 evaluate a list starting with a symbol like @code{+}, you will get a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1751 value returned that is the result of the computer carrying out the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1752 instructions in the function definition attached to that name. If a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1753 symbol by itself is evaluated, something different happens, as we will
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1754 see in the next section.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1755
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1756 @node Variables, Arguments, Evaluation, List Processing
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1757 @comment node-name, next, previous, up
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1758 @section Variables
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1759 @cindex Variables
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1760
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1761 In Emacs Lisp, a symbol can have a value attached to it just as it can
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1762 have a function definition attached to it. The two are different.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1763 The function definition is a set of instructions that a computer will
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1764 obey. A value, on the other hand, is something, such as number or a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1765 name, that can vary (which is why such a symbol is called a variable).
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1766 The value of a symbol can be any expression in Lisp, such as a symbol,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1767 number, list, or string. A symbol that has a value is often called a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1768 @dfn{variable}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1769
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1770 A symbol can have both a function definition and a value attached to
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1771 it at the same time. Or it can have just one or the other.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1772 The two are separate. This is somewhat similar
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1773 to the way the name Cambridge can refer to the city in Massachusetts
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1774 and have some information attached to the name as well, such as
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1775 ``great programming center''.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1776
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1777 @ignore
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1778 (Incidentally, in Emacs Lisp, a symbol can have two
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1779 other things attached to it, too: a property list and a documentation
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1780 string; these are discussed later.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1781 @end ignore
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1782
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1783 Another way to think about this is to imagine a symbol as being a chest
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1784 of drawers. The function definition is put in one drawer, the value in
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1785 another, and so on. What is put in the drawer holding the value can be
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1786 changed without affecting the contents of the drawer holding the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1787 function definition, and vice-verse.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1788
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1789 @menu
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1790 * fill-column Example::
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1791 * Void Function:: The error message for a symbol
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1792 without a function.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1793 * Void Variable:: The error message for a symbol without a value.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1794 @end menu
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1795
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1796 @node fill-column Example, Void Function, Variables, Variables
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1797 @ifnottex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1798 @unnumberedsubsec @code{fill-column}, an Example Variable
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1799 @end ifnottex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1800
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1801 @findex fill-column, @r{an example variable}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1802 @cindex Example variable, @code{fill-column}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1803 @cindex Variable, example of, @code{fill-column}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1804 The variable @code{fill-column} illustrates a symbol with a value
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1805 attached to it: in every GNU Emacs buffer, this symbol is set to some
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1806 value, usually 72 or 70, but sometimes to some other value. To find the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1807 value of this symbol, evaluate it by itself. If you are reading this in
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1808 Info inside of GNU Emacs, you can do this by putting the cursor after
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1809 the symbol and typing @kbd{C-x C-e}:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1810
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1811 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1812 fill-column
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1813 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1814
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1815 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1816 After I typed @kbd{C-x C-e}, Emacs printed the number 72 in my echo
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1817 area. This is the value for which @code{fill-column} is set for me as I
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1818 write this. It may be different for you in your Info buffer. Notice
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1819 that the value returned as a variable is printed in exactly the same way
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1820 as the value returned by a function carrying out its instructions. From
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1821 the point of view of the Lisp interpreter, a value returned is a value
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1822 returned. What kind of expression it came from ceases to matter once
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1823 the value is known.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1824
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1825 A symbol can have any value attached to it or, to use the jargon, we can
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1826 @dfn{bind} the variable to a value: to a number, such as 72; to a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1827 string, @code{"such as this"}; to a list, such as @code{(spruce pine
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1828 oak)}; we can even bind a variable to a function definition.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1829
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1830 A symbol can be bound to a value in several ways. @xref{set & setq, ,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1831 Setting the Value of a Variable}, for information about one way to do
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1832 this.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1833
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1834 @node Void Function, Void Variable, fill-column Example, Variables
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1835 @comment node-name, next, previous, up
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1836 @subsection Error Message for a Symbol Without a Function
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1837 @cindex Symbol without function error
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1838 @cindex Error for symbol without function
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1839
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1840 When we evaluated @code{fill-column} to find its value as a variable,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1841 we did not place parentheses around the word. This is because we did
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1842 not intend to use it as a function name.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1843
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1844 If @code{fill-column} were the first or only element of a list, the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1845 Lisp interpreter would attempt to find the function definition
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1846 attached to it. But @code{fill-column} has no function definition.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1847 Try evaluating this:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1848
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1849 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1850 (fill-column)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1851 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1852
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1853 @need 1250
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1854 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1855 In GNU Emacs version 22, you will create a @file{*Backtrace*} buffer
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1856 that says:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1857
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1858 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1859 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1860 ---------- Buffer: *Backtrace* ----------
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1861 Debugger entered--Lisp error: (void-function fill-column)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1862 (fill-column)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1863 eval((fill-column))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1864 eval-last-sexp-1(nil)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1865 eval-last-sexp(nil)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1866 call-interactively(eval-last-sexp)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1867 ---------- Buffer: *Backtrace* ----------
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1868 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1869 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1870
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1871 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1872 (Remember, to quit the debugger and make the debugger window go away,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1873 type @kbd{q} in the @file{*Backtrace*} buffer.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1874
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1875 @ignore
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1876 @need 800
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1877 In GNU Emacs 20 and before, you will produce an error message that says:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1878
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1879 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1880 Symbol's function definition is void:@: fill-column
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1881 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1882
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1883 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1884 (The message will go away as soon as you move the cursor or type
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1885 another key.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1886 @end ignore
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1887
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1888 @node Void Variable, , Void Function, Variables
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1889 @comment node-name, next, previous, up
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1890 @subsection Error Message for a Symbol Without a Value
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1891 @cindex Symbol without value error
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1892 @cindex Error for symbol without value
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1893
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1894 If you attempt to evaluate a symbol that does not have a value bound to
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1895 it, you will receive an error message. You can see this by
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1896 experimenting with our 2 plus 2 addition. In the following expression,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1897 put your cursor right after the @code{+}, before the first number 2,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1898 type @kbd{C-x C-e}:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1899
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1900 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1901 (+ 2 2)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1902 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1903
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1904 @need 1500
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1905 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1906 In GNU Emacs 22, you will create a @file{*Backtrace*} buffer that
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1907 says:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1908
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1909 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1910 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1911 ---------- Buffer: *Backtrace* ----------
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1912 Debugger entered--Lisp error: (void-variable +)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1913 eval(+)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1914 eval-last-sexp-1(nil)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1915 eval-last-sexp(nil)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1916 call-interactively(eval-last-sexp)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1917 ---------- Buffer: *Backtrace* ----------
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1918 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1919 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1920
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1921 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1922 (As with the other times we entered the debugger, you can quit by
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1923 typing @kbd{q} in the @file{*Backtrace*} buffer.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1924
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1925 This backtrace is different from the very first error message we saw,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1926 which said, @samp{Debugger entered--Lisp error: (void-function this)}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1927 In this case, the function does not have a value as a variable; while
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1928 in the other error message, the function (the word `this') did not
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1929 have a definition.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1930
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1931 In this experiment with the @code{+}, what we did was cause the Lisp
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1932 interpreter to evaluate the @code{+} and look for the value of the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1933 variable instead of the function definition. We did this by placing the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1934 cursor right after the symbol rather than after the parenthesis of the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1935 enclosing list as we did before. As a consequence, the Lisp interpreter
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1936 evaluated the preceding s-expression, which in this case was the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1937 @code{+} by itself.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1938
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1939 Since @code{+} does not have a value bound to it, just the function
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1940 definition, the error message reported that the symbol's value as a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1941 variable was void.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1942
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1943 @ignore
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1944 @need 800
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1945 In GNU Emacs version 20 and before, your error message will say:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1946
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1947 @example
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1948 Symbol's value as variable is void:@: +
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1949 @end example
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1950
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1951 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1952 The meaning is the same as in GNU Emacs 22.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1953 @end ignore
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1954
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1955 @node Arguments, set & setq, Variables, List Processing
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1956 @comment node-name, next, previous, up
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1957 @section Arguments
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1958 @cindex Arguments
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1959 @cindex Passing information to functions
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1960
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1961 To see how information is passed to functions, let's look again at
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1962 our old standby, the addition of two plus two. In Lisp, this is written
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1963 as follows:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1964
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1965 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1966 (+ 2 2)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1967 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1968
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1969 If you evaluate this expression, the number 4 will appear in your echo
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1970 area. What the Lisp interpreter does is add the numbers that follow
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1971 the @code{+}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1972
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1973 @cindex @samp{argument} defined
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1974 The numbers added by @code{+} are called the @dfn{arguments} of the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1975 function @code{+}. These numbers are the information that is given to
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1976 or @dfn{passed} to the function.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1977
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1978 The word `argument' comes from the way it is used in mathematics and
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1979 does not refer to a disputation between two people; instead it refers to
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1980 the information presented to the function, in this case, to the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1981 @code{+}. In Lisp, the arguments to a function are the atoms or lists
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1982 that follow the function. The values returned by the evaluation of
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1983 these atoms or lists are passed to the function. Different functions
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1984 require different numbers of arguments; some functions require none at
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1985 all.@footnote{It is curious to track the path by which the word `argument'
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1986 came to have two different meanings, one in mathematics and the other in
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1987 everyday English. According to the @cite{Oxford English Dictionary},
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1988 the word derives from the Latin for @samp{to make clear, prove}; thus it
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1989 came to mean, by one thread of derivation, `the evidence offered as
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1990 proof', which is to say, `the information offered', which led to its
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1991 meaning in Lisp. But in the other thread of derivation, it came to mean
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1992 `to assert in a manner against which others may make counter
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1993 assertions', which led to the meaning of the word as a disputation.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1994 (Note here that the English word has two different definitions attached
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1995 to it at the same time. By contrast, in Emacs Lisp, a symbol cannot
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1996 have two different function definitions at the same time.)}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1997
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1998 @menu
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1999 * Data types:: Types of data passed to a function.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2000 * Args as Variable or List:: An argument can be the value
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2001 of a variable or list.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2002 * Variable Number of Arguments:: Some functions may take a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2003 variable number of arguments.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2004 * Wrong Type of Argument:: Passing an argument of the wrong type
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2005 to a function.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2006 * message:: A useful function for sending messages.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2007 @end menu
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2008
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2009 @node Data types, Args as Variable or List, Arguments, Arguments
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2010 @comment node-name, next, previous, up
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2011 @subsection Arguments' Data Types
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2012 @cindex Data types
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2013 @cindex Types of data
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2014 @cindex Arguments' data types
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2015
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2016 The type of data that should be passed to a function depends on what
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2017 kind of information it uses. The arguments to a function such as
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2018 @code{+} must have values that are numbers, since @code{+} adds numbers.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2019 Other functions use different kinds of data for their arguments.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2020
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2021 @need 1250
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2022 @findex concat
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2023 For example, the @code{concat} function links together or unites two or
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2024 more strings of text to produce a string. The arguments are strings.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2025 Concatenating the two character strings @code{abc}, @code{def} produces
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2026 the single string @code{abcdef}. This can be seen by evaluating the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2027 following:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2028
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2029 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2030 (concat "abc" "def")
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2031 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2032
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2033 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2034 The value produced by evaluating this expression is @code{"abcdef"}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2035
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2036 A function such as @code{substring} uses both a string and numbers as
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2037 arguments. The function returns a part of the string, a substring of
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2038 the first argument. This function takes three arguments. Its first
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2039 argument is the string of characters, the second and third arguments are
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2040 numbers that indicate the beginning and end of the substring. The
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2041 numbers are a count of the number of characters (including spaces and
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2042 punctuations) from the beginning of the string.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2043
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2044 @need 800
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2045 For example, if you evaluate the following:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2046
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2047 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2048 (substring "The quick brown fox jumped." 16 19)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2049 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2050
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2051 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2052 you will see @code{"fox"} appear in the echo area. The arguments are the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2053 string and the two numbers.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2054
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2055 Note that the string passed to @code{substring} is a single atom even
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2056 though it is made up of several words separated by spaces. Lisp counts
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2057 everything between the two quotation marks as part of the string,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2058 including the spaces. You can think of the @code{substring} function as
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2059 a kind of `atom smasher' since it takes an otherwise indivisible atom
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2060 and extracts a part. However, @code{substring} is only able to extract
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2061 a substring from an argument that is a string, not from another type of
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2062 atom such as a number or symbol.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2063
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2064 @node Args as Variable or List, Variable Number of Arguments, Data types, Arguments
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2065 @comment node-name, next, previous, up
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2066 @subsection An Argument as the Value of a Variable or List
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2067
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2068 An argument can be a symbol that returns a value when it is evaluated.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2069 For example, when the symbol @code{fill-column} by itself is evaluated,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2070 it returns a number. This number can be used in an addition.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2071
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2072 @need 1250
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2073 Position the cursor after the following expression and type @kbd{C-x
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2074 C-e}:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2075
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2076 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2077 (+ 2 fill-column)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2078 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2079
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2080 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2081 The value will be a number two more than what you get by evaluating
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2082 @code{fill-column} alone. For me, this is 74, because my value of
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2083 @code{fill-column} is 72.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2084
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2085 As we have just seen, an argument can be a symbol that returns a value
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2086 when evaluated. In addition, an argument can be a list that returns a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2087 value when it is evaluated. For example, in the following expression,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2088 the arguments to the function @code{concat} are the strings
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2089 @w{@code{"The "}} and @w{@code{" red foxes."}} and the list
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2090 @code{(number-to-string (+ 2 fill-column))}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2091
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2092 @c For GNU Emacs 22, need number-to-string
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2093 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2094 (concat "The " (number-to-string (+ 2 fill-column)) " red foxes.")
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2095 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2096
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2097 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2098 If you evaluate this expression---and if, as with my Emacs,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2099 @code{fill-column} evaluates to 72---@code{"The 74 red foxes."} will
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2100 appear in the echo area. (Note that you must put spaces after the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2101 word @samp{The} and before the word @samp{red} so they will appear in
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2102 the final string. The function @code{number-to-string} converts the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2103 integer that the addition function returns to a string.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2104 @code{number-to-string} is also known as @code{int-to-string}.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2105
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2106 @node Variable Number of Arguments, Wrong Type of Argument, Args as Variable or List, Arguments
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2107 @comment node-name, next, previous, up
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2108 @subsection Variable Number of Arguments
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2109 @cindex Variable number of arguments
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2110 @cindex Arguments, variable number of
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2111
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2112 Some functions, such as @code{concat}, @code{+} or @code{*}, take any
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2113 number of arguments. (The @code{*} is the symbol for multiplication.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2114 This can be seen by evaluating each of the following expressions in
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2115 the usual way. What you will see in the echo area is printed in this
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2116 text after @samp{@result{}}, which you may read as `evaluates to'.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2117
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2118 @need 1250
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2119 In the first set, the functions have no arguments:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2120
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2121 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2122 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2123 (+) @result{} 0
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2124
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2125 (*) @result{} 1
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2126 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2127 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2128
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2129 @need 1250
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2130 In this set, the functions have one argument each:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2131
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2132 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2133 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2134 (+ 3) @result{} 3
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2135
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2136 (* 3) @result{} 3
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2137 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2138 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2139
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2140 @need 1250
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2141 In this set, the functions have three arguments each:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2142
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2143 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2144 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2145 (+ 3 4 5) @result{} 12
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2146
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2147 (* 3 4 5) @result{} 60
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2148 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2149 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2150
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2151 @node Wrong Type of Argument, message, Variable Number of Arguments, Arguments
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2152 @comment node-name, next, previous, up
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2153 @subsection Using the Wrong Type Object as an Argument
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2154 @cindex Wrong type of argument
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2155 @cindex Argument, wrong type of
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2156
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2157 When a function is passed an argument of the wrong type, the Lisp
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2158 interpreter produces an error message. For example, the @code{+}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2159 function expects the values of its arguments to be numbers. As an
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2160 experiment we can pass it the quoted symbol @code{hello} instead of a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2161 number. Position the cursor after the following expression and type
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2162 @kbd{C-x C-e}:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2163
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2164 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2165 (+ 2 'hello)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2166 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2167
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2168 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2169 When you do this you will generate an error message. What has happened
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2170 is that @code{+} has tried to add the 2 to the value returned by
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2171 @code{'hello}, but the value returned by @code{'hello} is the symbol
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2172 @code{hello}, not a number. Only numbers can be added. So @code{+}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2173 could not carry out its addition.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2174
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2175 @need 1250
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2176 In GNU Emacs version 22, you will create and enter a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2177 @file{*Backtrace*} buffer that says:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2178
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2179 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2180 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2181 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2182 ---------- Buffer: *Backtrace* ----------
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2183 Debugger entered--Lisp error:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2184 (wrong-type-argument number-or-marker-p hello)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2185 +(2 hello)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2186 eval((+ 2 (quote hello)))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2187 eval-last-sexp-1(nil)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2188 eval-last-sexp(nil)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2189 call-interactively(eval-last-sexp)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2190 ---------- Buffer: *Backtrace* ----------
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2191 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2192 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2193
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2194 @need 1250
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2195 As usual, the error message tries to be helpful and makes sense after you
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2196 learn how to read it.@footnote{@code{(quote hello)} is an expansion of
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2197 the abbreviation @code{'hello}.}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2198
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2199 The first part of the error message is straightforward; it says
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2200 @samp{wrong type argument}. Next comes the mysterious jargon word
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2201 @w{@samp{number-or-marker-p}}. This word is trying to tell you what
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2202 kind of argument the @code{+} expected.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2203
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2204 The symbol @code{number-or-marker-p} says that the Lisp interpreter is
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2205 trying to determine whether the information presented it (the value of
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2206 the argument) is a number or a marker (a special object representing a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2207 buffer position). What it does is test to see whether the @code{+} is
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2208 being given numbers to add. It also tests to see whether the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2209 argument is something called a marker, which is a specific feature of
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2210 Emacs Lisp. (In Emacs, locations in a buffer are recorded as markers.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2211 When the mark is set with the @kbd{C-@@} or @kbd{C-@key{SPC}} command,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2212 its position is kept as a marker. The mark can be considered a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2213 number---the number of characters the location is from the beginning
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2214 of the buffer.) In Emacs Lisp, @code{+} can be used to add the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2215 numeric value of marker positions as numbers.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2216
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2217 The @samp{p} of @code{number-or-marker-p} is the embodiment of a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2218 practice started in the early days of Lisp programming. The @samp{p}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2219 stands for `predicate'. In the jargon used by the early Lisp
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2220 researchers, a predicate refers to a function to determine whether some
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2221 property is true or false. So the @samp{p} tells us that
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2222 @code{number-or-marker-p} is the name of a function that determines
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2223 whether it is true or false that the argument supplied is a number or
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2224 a marker. Other Lisp symbols that end in @samp{p} include @code{zerop},
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2225 a function that tests whether its argument has the value of zero, and
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2226 @code{listp}, a function that tests whether its argument is a list.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2227
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2228 Finally, the last part of the error message is the symbol @code{hello}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2229 This is the value of the argument that was passed to @code{+}. If the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2230 addition had been passed the correct type of object, the value passed
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2231 would have been a number, such as 37, rather than a symbol like
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2232 @code{hello}. But then you would not have got the error message.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2233
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2234 @ignore
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2235 @need 1250
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2236 In GNU Emacs version 20 and before, the echo area displays an error
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2237 message that says:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2238
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2239 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2240 Wrong type argument:@: number-or-marker-p, hello
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2241 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2242
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2243 This says, in different words, the same as the top line of the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2244 @file{*Backtrace*} buffer.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2245 @end ignore
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2246
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2247 @node message, , Wrong Type of Argument, Arguments
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2248 @comment node-name, next, previous, up
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2249 @subsection The @code{message} Function
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2250 @findex message
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2251
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2252 Like @code{+}, the @code{message} function takes a variable number of
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2253 arguments. It is used to send messages to the user and is so useful
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2254 that we will describe it here.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2255
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2256 @need 1250
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2257 A message is printed in the echo area. For example, you can print a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2258 message in your echo area by evaluating the following list:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2259
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2260 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2261 (message "This message appears in the echo area!")
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2262 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2263
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2264 The whole string between double quotation marks is a single argument
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2265 and is printed @i{in toto}. (Note that in this example, the message
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2266 itself will appear in the echo area within double quotes; that is
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2267 because you see the value returned by the @code{message} function. In
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2268 most uses of @code{message} in programs that you write, the text will
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2269 be printed in the echo area as a side-effect, without the quotes.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2270 @xref{multiply-by-seven in detail, , @code{multiply-by-seven} in
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2271 detail}, for an example of this.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2272
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2273 However, if there is a @samp{%s} in the quoted string of characters, the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2274 @code{message} function does not print the @samp{%s} as such, but looks
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2275 to the argument that follows the string. It evaluates the second
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2276 argument and prints the value at the location in the string where the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2277 @samp{%s} is.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2278
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2279 @need 1250
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2280 You can see this by positioning the cursor after the following
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2281 expression and typing @kbd{C-x C-e}:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2282
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2283 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2284 (message "The name of this buffer is: %s." (buffer-name))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2285 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2286
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2287 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2288 In Info, @code{"The name of this buffer is: *info*."} will appear in the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2289 echo area. The function @code{buffer-name} returns the name of the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2290 buffer as a string, which the @code{message} function inserts in place
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2291 of @code{%s}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2292
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2293 To print a value as an integer, use @samp{%d} in the same way as
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2294 @samp{%s}. For example, to print a message in the echo area that
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2295 states the value of the @code{fill-column}, evaluate the following:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2296
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2297 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2298 (message "The value of fill-column is %d." fill-column)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2299 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2300
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2301 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2302 On my system, when I evaluate this list, @code{"The value of
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2303 fill-column is 72."} appears in my echo area@footnote{Actually, you
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2304 can use @code{%s} to print a number. It is non-specific. @code{%d}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2305 prints only the part of a number left of a decimal point, and not
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2306 anything that is not a number.}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2307
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2308 If there is more than one @samp{%s} in the quoted string, the value of
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2309 the first argument following the quoted string is printed at the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2310 location of the first @samp{%s} and the value of the second argument is
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2311 printed at the location of the second @samp{%s}, and so on.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2312
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2313 @need 1250
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2314 For example, if you evaluate the following,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2315
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2316 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2317 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2318 (message "There are %d %s in the office!"
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2319 (- fill-column 14) "pink elephants")
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2320 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2321 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2322
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2323 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2324 a rather whimsical message will appear in your echo area. On my system
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2325 it says, @code{"There are 58 pink elephants in the office!"}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2326
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2327 The expression @code{(- fill-column 14)} is evaluated and the resulting
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2328 number is inserted in place of the @samp{%d}; and the string in double
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2329 quotes, @code{"pink elephants"}, is treated as a single argument and
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2330 inserted in place of the @samp{%s}. (That is to say, a string between
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2331 double quotes evaluates to itself, like a number.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2332
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2333 Finally, here is a somewhat complex example that not only illustrates
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2334 the computation of a number, but also shows how you can use an
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2335 expression within an expression to generate the text that is substituted
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2336 for @samp{%s}:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2337
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2338 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2339 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2340 (message "He saw %d %s"
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2341 (- fill-column 32)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2342 (concat "red "
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2343 (substring
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2344 "The quick brown foxes jumped." 16 21)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2345 " leaping."))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2346 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2347 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2348
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2349 In this example, @code{message} has three arguments: the string,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2350 @code{"He saw %d %s"}, the expression, @code{(- fill-column 32)}, and
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2351 the expression beginning with the function @code{concat}. The value
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2352 resulting from the evaluation of @code{(- fill-column 32)} is inserted
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2353 in place of the @samp{%d}; and the value returned by the expression
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2354 beginning with @code{concat} is inserted in place of the @samp{%s}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2355
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2356 When your fill column is 70 and you evaluate the expression, the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2357 message @code{"He saw 38 red foxes leaping."} appears in your echo
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2358 area.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2359
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2360 @node set & setq, Summary, Arguments, List Processing
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2361 @comment node-name, next, previous, up
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2362 @section Setting the Value of a Variable
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2363 @cindex Variable, setting value
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2364 @cindex Setting value of variable
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2365
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2366 @cindex @samp{bind} defined
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2367 There are several ways by which a variable can be given a value. One of
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2368 the ways is to use either the function @code{set} or the function
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2369 @code{setq}. Another way is to use @code{let} (@pxref{let}). (The
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2370 jargon for this process is to @dfn{bind} a variable to a value.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2371
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2372 The following sections not only describe how @code{set} and @code{setq}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2373 work but also illustrate how arguments are passed.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2374
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2375 @menu
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2376 * Using set:: Setting values.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2377 * Using setq:: Setting a quoted value.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2378 * Counting:: Using @code{setq} to count.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2379 @end menu
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2380
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2381 @node Using set, Using setq, set & setq, set & setq
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2382 @comment node-name, next, previous, up
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2383 @subsection Using @code{set}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2384 @findex set
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2385
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2386 To set the value of the symbol @code{flowers} to the list @code{'(rose
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2387 violet daisy buttercup)}, evaluate the following expression by
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2388 positioning the cursor after the expression and typing @kbd{C-x C-e}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2389
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2390 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2391 (set 'flowers '(rose violet daisy buttercup))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2392 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2393
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2394 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2395 The list @code{(rose violet daisy buttercup)} will appear in the echo
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2396 area. This is what is @emph{returned} by the @code{set} function. As a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2397 side effect, the symbol @code{flowers} is bound to the list; that is,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2398 the symbol @code{flowers}, which can be viewed as a variable, is given
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2399 the list as its value. (This process, by the way, illustrates how a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2400 side effect to the Lisp interpreter, setting the value, can be the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2401 primary effect that we humans are interested in. This is because every
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2402 Lisp function must return a value if it does not get an error, but it
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2403 will only have a side effect if it is designed to have one.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2404
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2405 After evaluating the @code{set} expression, you can evaluate the symbol
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2406 @code{flowers} and it will return the value you just set. Here is the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2407 symbol. Place your cursor after it and type @kbd{C-x C-e}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2408
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2409 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2410 flowers
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2411 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2412
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2413 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2414 When you evaluate @code{flowers}, the list
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2415 @code{(rose violet daisy buttercup)} appears in the echo area.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2416
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2417 Incidentally, if you evaluate @code{'flowers}, the variable with a quote
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2418 in front of it, what you will see in the echo area is the symbol itself,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2419 @code{flowers}. Here is the quoted symbol, so you can try this:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2420
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2421 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2422 'flowers
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2423 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2424
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2425 Note also, that when you use @code{set}, you need to quote both
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2426 arguments to @code{set}, unless you want them evaluated. Since we do
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2427 not want either argument evaluated, neither the variable
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2428 @code{flowers} nor the list @code{(rose violet daisy buttercup)}, both
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2429 are quoted. (When you use @code{set} without quoting its first
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2430 argument, the first argument is evaluated before anything else is
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2431 done. If you did this and @code{flowers} did not have a value
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2432 already, you would get an error message that the @samp{Symbol's value
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2433 as variable is void}; on the other hand, if @code{flowers} did return
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2434 a value after it was evaluated, the @code{set} would attempt to set
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2435 the value that was returned. There are situations where this is the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2436 right thing for the function to do; but such situations are rare.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2437
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2438 @node Using setq, Counting, Using set, set & setq
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2439 @comment node-name, next, previous, up
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2440 @subsection Using @code{setq}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2441 @findex setq
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2442
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2443 As a practical matter, you almost always quote the first argument to
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2444 @code{set}. The combination of @code{set} and a quoted first argument
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2445 is so common that it has its own name: the special form @code{setq}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2446 This special form is just like @code{set} except that the first argument
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2447 is quoted automatically, so you don't need to type the quote mark
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2448 yourself. Also, as an added convenience, @code{setq} permits you to set
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2449 several different variables to different values, all in one expression.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2450
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2451 To set the value of the variable @code{carnivores} to the list
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2452 @code{'(lion tiger leopard)} using @code{setq}, the following expression
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2453 is used:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2454
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2455 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2456 (setq carnivores '(lion tiger leopard))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2457 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2458
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2459 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2460 This is exactly the same as using @code{set} except the first argument
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2461 is automatically quoted by @code{setq}. (The @samp{q} in @code{setq}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2462 means @code{quote}.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2463
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2464 @need 1250
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2465 With @code{set}, the expression would look like this:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2466
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2467 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2468 (set 'carnivores '(lion tiger leopard))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2469 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2470
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2471 Also, @code{setq} can be used to assign different values to
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2472 different variables. The first argument is bound to the value
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2473 of the second argument, the third argument is bound to the value of the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2474 fourth argument, and so on. For example, you could use the following to
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2475 assign a list of trees to the symbol @code{trees} and a list of herbivores
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2476 to the symbol @code{herbivores}:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2477
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2478 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2479 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2480 (setq trees '(pine fir oak maple)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2481 herbivores '(gazelle antelope zebra))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2482 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2483 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2484
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2485 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2486 (The expression could just as well have been on one line, but it might
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2487 not have fit on a page; and humans find it easier to read nicely
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2488 formatted lists.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2489
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2490 Although I have been using the term `assign', there is another way of
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2491 thinking about the workings of @code{set} and @code{setq}; and that is to
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2492 say that @code{set} and @code{setq} make the symbol @emph{point} to the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2493 list. This latter way of thinking is very common and in forthcoming
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2494 chapters we shall come upon at least one symbol that has `pointer' as
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2495 part of its name. The name is chosen because the symbol has a value,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2496 specifically a list, attached to it; or, expressed another way,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2497 the symbol is set to ``point'' to the list.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2498
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2499 @node Counting, , Using setq, set & setq
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2500 @comment node-name, next, previous, up
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2501 @subsection Counting
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2502 @cindex Counting
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2503
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2504 Here is an example that shows how to use @code{setq} in a counter. You
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2505 might use this to count how many times a part of your program repeats
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2506 itself. First set a variable to zero; then add one to the number each
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2507 time the program repeats itself. To do this, you need a variable that
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2508 serves as a counter, and two expressions: an initial @code{setq}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2509 expression that sets the counter variable to zero; and a second
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2510 @code{setq} expression that increments the counter each time it is
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2511 evaluated.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2512
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2513 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2514 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2515 (setq counter 0) ; @r{Let's call this the initializer.}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2516
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2517 (setq counter (+ counter 1)) ; @r{This is the incrementer.}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2518
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2519 counter ; @r{This is the counter.}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2520 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2521 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2522
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2523 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2524 (The text following the @samp{;} are comments. @xref{Change a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2525 defun, , Change a Function Definition}.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2526
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2527 If you evaluate the first of these expressions, the initializer,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2528 @code{(setq counter 0)}, and then evaluate the third expression,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2529 @code{counter}, the number @code{0} will appear in the echo area. If
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2530 you then evaluate the second expression, the incrementer, @code{(setq
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2531 counter (+ counter 1))}, the counter will get the value 1. So if you
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2532 again evaluate @code{counter}, the number @code{1} will appear in the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2533 echo area. Each time you evaluate the second expression, the value of
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2534 the counter will be incremented.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2535
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2536 When you evaluate the incrementer, @code{(setq counter (+ counter 1))},
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2537 the Lisp interpreter first evaluates the innermost list; this is the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2538 addition. In order to evaluate this list, it must evaluate the variable
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2539 @code{counter} and the number @code{1}. When it evaluates the variable
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2540 @code{counter}, it receives its current value. It passes this value and
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2541 the number @code{1} to the @code{+} which adds them together. The sum
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2542 is then returned as the value of the inner list and passed to the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2543 @code{setq} which sets the variable @code{counter} to this new value.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2544 Thus, the value of the variable, @code{counter}, is changed.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2545
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2546 @node Summary, Error Message Exercises, set & setq, List Processing
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2547 @comment node-name, next, previous, up
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2548 @section Summary
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2549
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2550 Learning Lisp is like climbing a hill in which the first part is the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2551 steepest. You have now climbed the most difficult part; what remains
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2552 becomes easier as you progress onwards.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2553
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2554 @need 1000
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2555 In summary,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2556
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2557 @itemize @bullet
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2558
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2559 @item
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2560 Lisp programs are made up of expressions, which are lists or single atoms.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2561
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2562 @item
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2563 Lists are made up of zero or more atoms or inner lists, separated by whitespace and
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2564 surrounded by parentheses. A list can be empty.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2565
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2566 @item
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2567 Atoms are multi-character symbols, like @code{forward-paragraph}, single
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2568 character symbols like @code{+}, strings of characters between double
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2569 quotation marks, or numbers.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2570
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2571 @item
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2572 A number evaluates to itself.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2573
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2574 @item
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2575 A string between double quotes also evaluates to itself.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2576
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2577 @item
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2578 When you evaluate a symbol by itself, its value is returned.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2579
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2580 @item
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2581 When you evaluate a list, the Lisp interpreter looks at the first symbol
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2582 in the list and then at the function definition bound to that symbol.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2583 Then the instructions in the function definition are carried out.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2584
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2585 @item
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2586 A single quotation mark,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2587 @ifinfo
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2588 '
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2589 @end ifinfo
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2590 @ifnotinfo
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2591 @code{'}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2592 @end ifnotinfo
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2593 , tells the Lisp interpreter that it should
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2594 return the following expression as written, and not evaluate it as it
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2595 would if the quote were not there.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2596
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2597 @item
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2598 Arguments are the information passed to a function. The arguments to a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2599 function are computed by evaluating the rest of the elements of the list
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2600 of which the function is the first element.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2601
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2602 @item
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2603 A function always returns a value when it is evaluated (unless it gets
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2604 an error); in addition, it may also carry out some action called a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2605 ``side effect''. In many cases, a function's primary purpose is to
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2606 create a side effect.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2607 @end itemize
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2608
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2609 @node Error Message Exercises, , Summary, List Processing
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2610 @comment node-name, next, previous, up
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2611 @section Exercises
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2612
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2613 A few simple exercises:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2614
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2615 @itemize @bullet
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2616 @item
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2617 Generate an error message by evaluating an appropriate symbol that is
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2618 not within parentheses.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2619
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2620 @item
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2621 Generate an error message by evaluating an appropriate symbol that is
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2622 between parentheses.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2623
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2624 @item
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2625 Create a counter that increments by two rather than one.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2626
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2627 @item
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2628 Write an expression that prints a message in the echo area when
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2629 evaluated.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2630 @end itemize
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2631
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2632 @node Practicing Evaluation, Writing Defuns, List Processing, Top
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2633 @comment node-name, next, previous, up
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2634 @chapter Practicing Evaluation
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2635 @cindex Practicing evaluation
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2636 @cindex Evaluation practice
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2637
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2638 Before learning how to write a function definition in Emacs Lisp, it is
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2639 useful to spend a little time evaluating various expressions that have
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2640 already been written. These expressions will be lists with the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2641 functions as their first (and often only) element. Since some of the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2642 functions associated with buffers are both simple and interesting, we
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2643 will start with those. In this section, we will evaluate a few of
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2644 these. In another section, we will study the code of several other
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2645 buffer-related functions, to see how they were written.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2646
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2647 @menu
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2648 * How to Evaluate:: Typing editing commands or @kbd{C-x C-e}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2649 causes evaluation.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2650 * Buffer Names:: Buffers and files are different.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2651 * Getting Buffers:: Getting a buffer itself, not merely its name.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2652 * Switching Buffers:: How to change to another buffer.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2653 * Buffer Size & Locations:: Where point is located and the size of
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2654 the buffer.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2655 * Evaluation Exercise::
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2656 @end menu
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2657
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2658 @node How to Evaluate, Buffer Names, Practicing Evaluation, Practicing Evaluation
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2659 @ifnottex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2660 @unnumberedsec How to Evaluate
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2661 @end ifnottex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2662
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2663 @i{Whenever you give an editing command} to Emacs Lisp, such as the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2664 command to move the cursor or to scroll the screen, @i{you are evaluating
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2665 an expression,} the first element of which is a function. @i{This is
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2666 how Emacs works.}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2667
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2668 @cindex @samp{interactive function} defined
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2669 @cindex @samp{command} defined
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2670 When you type keys, you cause the Lisp interpreter to evaluate an
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2671 expression and that is how you get your results. Even typing plain text
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2672 involves evaluating an Emacs Lisp function, in this case, one that uses
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2673 @code{self-insert-command}, which simply inserts the character you
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2674 typed. The functions you evaluate by typing keystrokes are called
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2675 @dfn{interactive} functions, or @dfn{commands}; how you make a function
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2676 interactive will be illustrated in the chapter on how to write function
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2677 definitions. @xref{Interactive, , Making a Function Interactive}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2678
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2679 In addition to typing keyboard commands, we have seen a second way to
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2680 evaluate an expression: by positioning the cursor after a list and
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2681 typing @kbd{C-x C-e}. This is what we will do in the rest of this
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2682 section. There are other ways to evaluate an expression as well; these
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2683 will be described as we come to them.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2684
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2685 Besides being used for practicing evaluation, the functions shown in the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2686 next few sections are important in their own right. A study of these
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2687 functions makes clear the distinction between buffers and files, how to
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2688 switch to a buffer, and how to determine a location within it.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2689
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2690 @node Buffer Names, Getting Buffers, How to Evaluate, Practicing Evaluation
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2691 @comment node-name, next, previous, up
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2692 @section Buffer Names
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2693 @findex buffer-name
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2694 @findex buffer-file-name
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2695
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2696 The two functions, @code{buffer-name} and @code{buffer-file-name}, show
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2697 the difference between a file and a buffer. When you evaluate the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2698 following expression, @code{(buffer-name)}, the name of the buffer
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2699 appears in the echo area. When you evaluate @code{(buffer-file-name)},
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2700 the name of the file to which the buffer refers appears in the echo
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2701 area. Usually, the name returned by @code{(buffer-name)} is the same as
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2702 the name of the file to which it refers, and the name returned by
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2703 @code{(buffer-file-name)} is the full path-name of the file.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2704
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2705 A file and a buffer are two different entities. A file is information
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2706 recorded permanently in the computer (unless you delete it). A buffer,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2707 on the other hand, is information inside of Emacs that will vanish at
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2708 the end of the editing session (or when you kill the buffer). Usually,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2709 a buffer contains information that you have copied from a file; we say
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2710 the buffer is @dfn{visiting} that file. This copy is what you work on
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2711 and modify. Changes to the buffer do not change the file, until you
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2712 save the buffer. When you save the buffer, the buffer is copied to the file
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2713 and is thus saved permanently.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2714
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2715 @need 1250
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2716 If you are reading this in Info inside of GNU Emacs, you can evaluate
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2717 each of the following expressions by positioning the cursor after it and
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2718 typing @kbd{C-x C-e}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2719
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2720 @example
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2721 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2722 (buffer-name)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2723
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2724 (buffer-file-name)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2725 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2726 @end example
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2727
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2728 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2729 When I do this in Info, the value returned by evaluating
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2730 @code{(buffer-name)} is @file{"*info*"}, and the value returned by
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2731 evaluating @code{(buffer-file-name)} is @file{nil}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2732
98525
b6395ec3de45 formatting fixes for new printed edition
Karl Berry <karl@gnu.org>
parents: 94896
diff changeset
2733 On the other hand, while I am writing this document, the value
83955
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2734 returned by evaluating @code{(buffer-name)} is
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2735 @file{"introduction.texinfo"}, and the value returned by evaluating
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2736 @code{(buffer-file-name)} is
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2737 @file{"/gnu/work/intro/introduction.texinfo"}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2738
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2739 @cindex @code{nil}, history of word
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2740 The former is the name of the buffer and the latter is the name of the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2741 file. In Info, the buffer name is @file{"*info*"}. Info does not
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2742 point to any file, so the result of evaluating
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2743 @code{(buffer-file-name)} is @file{nil}. The symbol @code{nil} is
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2744 from the Latin word for `nothing'; in this case, it means that the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2745 buffer is not associated with any file. (In Lisp, @code{nil} is also
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2746 used to mean `false' and is a synonym for the empty list, @code{()}.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2747
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2748 When I am writing, the name of my buffer is
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2749 @file{"introduction.texinfo"}. The name of the file to which it
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2750 points is @file{"/gnu/work/intro/introduction.texinfo"}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2751
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2752 (In the expressions, the parentheses tell the Lisp interpreter to
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2753 treat @w{@code{buffer-name}} and @w{@code{buffer-file-name}} as
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2754 functions; without the parentheses, the interpreter would attempt to
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2755 evaluate the symbols as variables. @xref{Variables}.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2756
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2757 In spite of the distinction between files and buffers, you will often
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2758 find that people refer to a file when they mean a buffer and vice-verse.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2759 Indeed, most people say, ``I am editing a file,'' rather than saying,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2760 ``I am editing a buffer which I will soon save to a file.'' It is
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2761 almost always clear from context what people mean. When dealing with
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2762 computer programs, however, it is important to keep the distinction in mind,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2763 since the computer is not as smart as a person.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2764
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2765 @cindex Buffer, history of word
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2766 The word `buffer', by the way, comes from the meaning of the word as a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2767 cushion that deadens the force of a collision. In early computers, a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2768 buffer cushioned the interaction between files and the computer's
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2769 central processing unit. The drums or tapes that held a file and the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2770 central processing unit were pieces of equipment that were very
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2771 different from each other, working at their own speeds, in spurts. The
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2772 buffer made it possible for them to work together effectively.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2773 Eventually, the buffer grew from being an intermediary, a temporary
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2774 holding place, to being the place where work is done. This
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2775 transformation is rather like that of a small seaport that grew into a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2776 great city: once it was merely the place where cargo was warehoused
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2777 temporarily before being loaded onto ships; then it became a business
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2778 and cultural center in its own right.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2779
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2780 Not all buffers are associated with files. For example, a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2781 @file{*scratch*} buffer does not visit any file. Similarly, a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2782 @file{*Help*} buffer is not associated with any file.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2783
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2784 In the old days, when you lacked a @file{~/.emacs} file and started an
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2785 Emacs session by typing the command @code{emacs} alone, without naming
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2786 any files, Emacs started with the @file{*scratch*} buffer visible.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2787 Nowadays, you will see a splash screen. You can follow one of the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2788 commands suggested on the splash screen, visit a file, or press the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2789 spacebar to reach the @file{*scratch*} buffer.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2790
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2791 If you switch to the @file{*scratch*} buffer, type
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2792 @code{(buffer-name)}, position the cursor after it, and then type
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2793 @kbd{C-x C-e} to evaluate the expression. The name @code{"*scratch*"}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2794 will be returned and will appear in the echo area. @code{"*scratch*"}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2795 is the name of the buffer. When you type @code{(buffer-file-name)} in
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2796 the @file{*scratch*} buffer and evaluate that, @code{nil} will appear
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2797 in the echo area, just as it does when you evaluate
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2798 @code{(buffer-file-name)} in Info.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2799
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2800 Incidentally, if you are in the @file{*scratch*} buffer and want the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2801 value returned by an expression to appear in the @file{*scratch*}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2802 buffer itself rather than in the echo area, type @kbd{C-u C-x C-e}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2803 instead of @kbd{C-x C-e}. This causes the value returned to appear
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2804 after the expression. The buffer will look like this:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2805
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2806 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2807 (buffer-name)"*scratch*"
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2808 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2809
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2810 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2811 You cannot do this in Info since Info is read-only and it will not allow
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2812 you to change the contents of the buffer. But you can do this in any
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2813 buffer you can edit; and when you write code or documentation (such as
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2814 this book), this feature is very useful.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2815
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2816 @node Getting Buffers, Switching Buffers, Buffer Names, Practicing Evaluation
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2817 @comment node-name, next, previous, up
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2818 @section Getting Buffers
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2819 @findex current-buffer
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2820 @findex other-buffer
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2821 @cindex Getting a buffer
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2822
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2823 The @code{buffer-name} function returns the @emph{name} of the buffer;
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2824 to get the buffer @emph{itself}, a different function is needed: the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2825 @code{current-buffer} function. If you use this function in code, what
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2826 you get is the buffer itself.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2827
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2828 A name and the object or entity to which the name refers are different
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2829 from each other. You are not your name. You are a person to whom
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2830 others refer by name. If you ask to speak to George and someone hands you
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2831 a card with the letters @samp{G}, @samp{e}, @samp{o}, @samp{r},
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2832 @samp{g}, and @samp{e} written on it, you might be amused, but you would
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2833 not be satisfied. You do not want to speak to the name, but to the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2834 person to whom the name refers. A buffer is similar: the name of the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2835 scratch buffer is @file{*scratch*}, but the name is not the buffer. To
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2836 get a buffer itself, you need to use a function such as
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2837 @code{current-buffer}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2838
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2839 However, there is a slight complication: if you evaluate
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2840 @code{current-buffer} in an expression on its own, as we will do here,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2841 what you see is a printed representation of the name of the buffer
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2842 without the contents of the buffer. Emacs works this way for two
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2843 reasons: the buffer may be thousands of lines long---too long to be
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2844 conveniently displayed; and, another buffer may have the same contents
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2845 but a different name, and it is important to distinguish between them.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2846
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2847 @need 800
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2848 Here is an expression containing the function:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2849
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2850 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2851 (current-buffer)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2852 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2853
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2854 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2855 If you evaluate this expression in Info in Emacs in the usual way,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2856 @file{#<buffer *info*>} will appear in the echo area. The special
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2857 format indicates that the buffer itself is being returned, rather than
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2858 just its name.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2859
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2860 Incidentally, while you can type a number or symbol into a program, you
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2861 cannot do that with the printed representation of a buffer: the only way
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2862 to get a buffer itself is with a function such as @code{current-buffer}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2863
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2864 A related function is @code{other-buffer}. This returns the most
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2865 recently selected buffer other than the one you are in currently, not
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2866 a printed representation of its name. If you have recently switched
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2867 back and forth from the @file{*scratch*} buffer, @code{other-buffer}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2868 will return that buffer.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2869
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2870 @need 800
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2871 You can see this by evaluating the expression:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2872
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2873 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2874 (other-buffer)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2875 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2876
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2877 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2878 You should see @file{#<buffer *scratch*>} appear in the echo area, or
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2879 the name of whatever other buffer you switched back from most
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2880 recently@footnote{Actually, by default, if the buffer from which you
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2881 just switched is visible to you in another window, @code{other-buffer}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2882 will choose the most recent buffer that you cannot see; this is a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2883 subtlety that I often forget.}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2884
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2885 @node Switching Buffers, Buffer Size & Locations, Getting Buffers, Practicing Evaluation
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2886 @comment node-name, next, previous, up
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2887 @section Switching Buffers
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2888 @findex switch-to-buffer
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2889 @findex set-buffer
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2890 @cindex Switching to a buffer
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2891
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2892 The @code{other-buffer} function actually provides a buffer when it is
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2893 used as an argument to a function that requires one. We can see this
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2894 by using @code{other-buffer} and @code{switch-to-buffer} to switch to a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2895 different buffer.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2896
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2897 But first, a brief introduction to the @code{switch-to-buffer}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2898 function. When you switched back and forth from Info to the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2899 @file{*scratch*} buffer to evaluate @code{(buffer-name)}, you most
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2900 likely typed @kbd{C-x b} and then typed @file{*scratch*}@footnote{Or
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2901 rather, to save typing, you probably only typed @kbd{RET} if the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2902 default buffer was @file{*scratch*}, or if it was different, then you
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2903 typed just part of the name, such as @code{*sc}, pressed your
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2904 @kbd{TAB} key to cause it to expand to the full name, and then typed
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2905 your @kbd{RET} key.} when prompted in the minibuffer for the name of
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2906 the buffer to which you wanted to switch. The keystrokes, @kbd{C-x
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2907 b}, cause the Lisp interpreter to evaluate the interactive function
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2908 @code{switch-to-buffer}. As we said before, this is how Emacs works:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2909 different keystrokes call or run different functions. For example,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2910 @kbd{C-f} calls @code{forward-char}, @kbd{M-e} calls
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2911 @code{forward-sentence}, and so on.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2912
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2913 By writing @code{switch-to-buffer} in an expression, and giving it a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2914 buffer to switch to, we can switch buffers just the way @kbd{C-x b}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2915 does.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2916
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2917 @need 1000
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2918 Here is the Lisp expression:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2919
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2920 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2921 (switch-to-buffer (other-buffer))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2922 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2923
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2924 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2925 The symbol @code{switch-to-buffer} is the first element of the list,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2926 so the Lisp interpreter will treat it as a function and carry out the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2927 instructions that are attached to it. But before doing that, the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2928 interpreter will note that @code{other-buffer} is inside parentheses
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2929 and work on that symbol first. @code{other-buffer} is the first (and
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2930 in this case, the only) element of this list, so the Lisp interpreter
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2931 calls or runs the function. It returns another buffer. Next, the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2932 interpreter runs @code{switch-to-buffer}, passing to it, as an
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2933 argument, the other buffer, which is what Emacs will switch to. If
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2934 you are reading this in Info, try this now. Evaluate the expression.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2935 (To get back, type @kbd{C-x b @key{RET}}.)@footnote{Remember, this
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2936 expression will move you to your most recent other buffer that you
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2937 cannot see. If you really want to go to your most recently selected
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2938 buffer, even if you can still see it, you need to evaluate the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2939 following more complex expression:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2940
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2941 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2942 (switch-to-buffer (other-buffer (current-buffer) t))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2943 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2944
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2945 @c noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2946 In this case, the first argument to @code{other-buffer} tells it which
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2947 buffer to skip---the current one---and the second argument tells
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2948 @code{other-buffer} it is OK to switch to a visible buffer.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2949 In regular use, @code{switch-to-buffer} takes you to an invisible
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2950 window since you would most likely use @kbd{C-x o} (@code{other-window})
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2951 to go to another visible buffer.}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2952
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2953 In the programming examples in later sections of this document, you will
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2954 see the function @code{set-buffer} more often than
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2955 @code{switch-to-buffer}. This is because of a difference between
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2956 computer programs and humans: humans have eyes and expect to see the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2957 buffer on which they are working on their computer terminals. This is
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2958 so obvious, it almost goes without saying. However, programs do not
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2959 have eyes. When a computer program works on a buffer, that buffer does
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2960 not need to be visible on the screen.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2961
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2962 @code{switch-to-buffer} is designed for humans and does two different
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2963 things: it switches the buffer to which Emacs' attention is directed; and
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2964 it switches the buffer displayed in the window to the new buffer.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2965 @code{set-buffer}, on the other hand, does only one thing: it switches
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2966 the attention of the computer program to a different buffer. The buffer
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2967 on the screen remains unchanged (of course, normally nothing happens
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2968 there until the command finishes running).
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2969
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2970 @cindex @samp{call} defined
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2971 Also, we have just introduced another jargon term, the word @dfn{call}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2972 When you evaluate a list in which the first symbol is a function, you
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2973 are calling that function. The use of the term comes from the notion of
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2974 the function as an entity that can do something for you if you `call'
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2975 it---just as a plumber is an entity who can fix a leak if you call him
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2976 or her.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2977
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2978 @node Buffer Size & Locations, Evaluation Exercise, Switching Buffers, Practicing Evaluation
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2979 @comment node-name, next, previous, up
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2980 @section Buffer Size and the Location of Point
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2981 @cindex Size of buffer
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2982 @cindex Buffer size
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2983 @cindex Point location
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2984 @cindex Location of point
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2985
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2986 Finally, let's look at several rather simple functions,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2987 @code{buffer-size}, @code{point}, @code{point-min}, and
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2988 @code{point-max}. These give information about the size of a buffer and
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2989 the location of point within it.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2990
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2991 The function @code{buffer-size} tells you the size of the current
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2992 buffer; that is, the function returns a count of the number of
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2993 characters in the buffer.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2994
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2995 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2996 (buffer-size)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2997 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2998
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2999 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3000 You can evaluate this in the usual way, by positioning the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3001 cursor after the expression and typing @kbd{C-x C-e}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3002
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3003 @cindex @samp{point} defined
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3004 In Emacs, the current position of the cursor is called @dfn{point}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3005 The expression @code{(point)} returns a number that tells you where the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3006 cursor is located as a count of the number of characters from the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3007 beginning of the buffer up to point.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3008
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3009 @need 1250
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3010 You can see the character count for point in this buffer by evaluating
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3011 the following expression in the usual way:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3012
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3013 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3014 (point)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3015 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3016
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3017 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3018 As I write this, the value of @code{point} is 65724. The @code{point}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3019 function is frequently used in some of the examples later in this
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3020 book.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3021
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3022 @need 1250
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3023 The value of point depends, of course, on its location within the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3024 buffer. If you evaluate point in this spot, the number will be larger:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3025
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3026 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3027 (point)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3028 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3029
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3030 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3031 For me, the value of point in this location is 66043, which means that
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3032 there are 319 characters (including spaces) between the two
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3033 expressions. (Doubtless, you will see different numbers, since I will
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3034 have edited this since I first evaluated point.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3035
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3036 @cindex @samp{narrowing} defined
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3037 The function @code{point-min} is somewhat similar to @code{point}, but
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3038 it returns the value of the minimum permissible value of point in the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3039 current buffer. This is the number 1 unless @dfn{narrowing} is in
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3040 effect. (Narrowing is a mechanism whereby you can restrict yourself,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3041 or a program, to operations on just a part of a buffer.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3042 @xref{Narrowing & Widening, , Narrowing and Widening}.) Likewise, the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3043 function @code{point-max} returns the value of the maximum permissible
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3044 value of point in the current buffer.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3045
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3046 @node Evaluation Exercise, , Buffer Size & Locations, Practicing Evaluation
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3047 @section Exercise
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3048
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3049 Find a file with which you are working and move towards its middle.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3050 Find its buffer name, file name, length, and your position in the file.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3051
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3052 @node Writing Defuns, Buffer Walk Through, Practicing Evaluation, Top
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3053 @comment node-name, next, previous, up
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3054 @chapter How To Write Function Definitions
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3055 @cindex Definition writing
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3056 @cindex Function definition writing
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3057 @cindex Writing a function definition
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3058
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3059 When the Lisp interpreter evaluates a list, it looks to see whether the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3060 first symbol on the list has a function definition attached to it; or,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3061 put another way, whether the symbol points to a function definition. If
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3062 it does, the computer carries out the instructions in the definition. A
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3063 symbol that has a function definition is called, simply, a function
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3064 (although, properly speaking, the definition is the function and the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3065 symbol refers to it.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3066
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3067 @menu
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3068 * Primitive Functions::
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3069 * defun:: The @code{defun} special form.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3070 * Install:: Install a function definition.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3071 * Interactive:: Making a function interactive.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3072 * Interactive Options:: Different options for @code{interactive}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3073 * Permanent Installation:: Installing code permanently.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3074 * let:: Creating and initializing local variables.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3075 * if:: What if?
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3076 * else:: If--then--else expressions.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3077 * Truth & Falsehood:: What Lisp considers false and true.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3078 * save-excursion:: Keeping track of point, mark, and buffer.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3079 * Review::
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3080 * defun Exercises::
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3081 @end menu
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3082
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3083 @node Primitive Functions, defun, Writing Defuns, Writing Defuns
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3084 @ifnottex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3085 @unnumberedsec An Aside about Primitive Functions
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3086 @end ifnottex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3087 @cindex Primitive functions
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3088 @cindex Functions, primitive
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3089
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3090 @cindex C language primitives
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3091 @cindex Primitives written in C
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3092 All functions are defined in terms of other functions, except for a few
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3093 @dfn{primitive} functions that are written in the C programming
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3094 language. When you write functions' definitions, you will write them in
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3095 Emacs Lisp and use other functions as your building blocks. Some of the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3096 functions you will use will themselves be written in Emacs Lisp (perhaps
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3097 by you) and some will be primitives written in C. The primitive
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3098 functions are used exactly like those written in Emacs Lisp and behave
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3099 like them. They are written in C so we can easily run GNU Emacs on any
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3100 computer that has sufficient power and can run C.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3101
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3102 Let me re-emphasize this: when you write code in Emacs Lisp, you do not
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3103 distinguish between the use of functions written in C and the use of
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3104 functions written in Emacs Lisp. The difference is irrelevant. I
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3105 mention the distinction only because it is interesting to know. Indeed,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3106 unless you investigate, you won't know whether an already-written
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3107 function is written in Emacs Lisp or C.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3108
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3109 @node defun, Install, Primitive Functions, Writing Defuns
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3110 @comment node-name, next, previous, up
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3111 @section The @code{defun} Special Form
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3112 @findex defun
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3113 @cindex Special form of @code{defun}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3114
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3115 @cindex @samp{function definition} defined
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3116 In Lisp, a symbol such as @code{mark-whole-buffer} has code attached to
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3117 it that tells the computer what to do when the function is called.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3118 This code is called the @dfn{function definition} and is created by
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3119 evaluating a Lisp expression that starts with the symbol @code{defun}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3120 (which is an abbreviation for @emph{define function}). Because
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3121 @code{defun} does not evaluate its arguments in the usual way, it is
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3122 called a @dfn{special form}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3123
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3124 In subsequent sections, we will look at function definitions from the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3125 Emacs source code, such as @code{mark-whole-buffer}. In this section,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3126 we will describe a simple function definition so you can see how it
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3127 looks. This function definition uses arithmetic because it makes for a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3128 simple example. Some people dislike examples using arithmetic; however,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3129 if you are such a person, do not despair. Hardly any of the code we
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3130 will study in the remainder of this introduction involves arithmetic or
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3131 mathematics. The examples mostly involve text in one way or another.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3132
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3133 A function definition has up to five parts following the word
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3134 @code{defun}:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3135
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3136 @enumerate
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3137 @item
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3138 The name of the symbol to which the function definition should be
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3139 attached.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3140
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3141 @item
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3142 A list of the arguments that will be passed to the function. If no
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3143 arguments will be passed to the function, this is an empty list,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3144 @code{()}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3145
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3146 @item
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3147 Documentation describing the function. (Technically optional, but
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3148 strongly recommended.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3149
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3150 @item
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3151 Optionally, an expression to make the function interactive so you can
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3152 use it by typing @kbd{M-x} and then the name of the function; or by
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3153 typing an appropriate key or keychord.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3154
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3155 @cindex @samp{body} defined
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3156 @item
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3157 The code that instructs the computer what to do: the @dfn{body} of the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3158 function definition.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3159 @end enumerate
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3160
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3161 It is helpful to think of the five parts of a function definition as
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3162 being organized in a template, with slots for each part:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3163
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3164 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3165 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3166 (defun @var{function-name} (@var{arguments}@dots{})
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3167 "@var{optional-documentation}@dots{}"
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3168 (interactive @var{argument-passing-info}) ; @r{optional}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3169 @var{body}@dots{})
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3170 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3171 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3172
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3173 As an example, here is the code for a function that multiplies its
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3174 argument by 7. (This example is not interactive. @xref{Interactive,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3175 , Making a Function Interactive}, for that information.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3176
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3177 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3178 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3179 (defun multiply-by-seven (number)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3180 "Multiply NUMBER by seven."
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3181 (* 7 number))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3182 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3183 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3184
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3185 This definition begins with a parenthesis and the symbol @code{defun},
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3186 followed by the name of the function.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3187
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3188 @cindex @samp{argument list} defined
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3189 The name of the function is followed by a list that contains the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3190 arguments that will be passed to the function. This list is called
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3191 the @dfn{argument list}. In this example, the list has only one
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3192 element, the symbol, @code{number}. When the function is used, the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3193 symbol will be bound to the value that is used as the argument to the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3194 function.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3195
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3196 Instead of choosing the word @code{number} for the name of the argument,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3197 I could have picked any other name. For example, I could have chosen
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3198 the word @code{multiplicand}. I picked the word `number' because it
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3199 tells what kind of value is intended for this slot; but I could just as
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3200 well have chosen the word `multiplicand' to indicate the role that the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3201 value placed in this slot will play in the workings of the function. I
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3202 could have called it @code{foogle}, but that would have been a bad
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3203 choice because it would not tell humans what it means. The choice of
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3204 name is up to the programmer and should be chosen to make the meaning of
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3205 the function clear.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3206
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3207 Indeed, you can choose any name you wish for a symbol in an argument
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3208 list, even the name of a symbol used in some other function: the name
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3209 you use in an argument list is private to that particular definition.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3210 In that definition, the name refers to a different entity than any use
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3211 of the same name outside the function definition. Suppose you have a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3212 nick-name `Shorty' in your family; when your family members refer to
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3213 `Shorty', they mean you. But outside your family, in a movie, for
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3214 example, the name `Shorty' refers to someone else. Because a name in an
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3215 argument list is private to the function definition, you can change the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3216 value of such a symbol inside the body of a function without changing
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3217 its value outside the function. The effect is similar to that produced
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3218 by a @code{let} expression. (@xref{let, , @code{let}}.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3219
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3220 @ignore
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3221 Note also that we discuss the word `number' in two different ways: as a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3222 symbol that appears in the code, and as the name of something that will
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3223 be replaced by a something else during the evaluation of the function.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3224 In the first case, @code{number} is a symbol, not a number; it happens
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3225 that within the function, it is a variable who value is the number in
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3226 question, but our primary interest in it is as a symbol. On the other
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3227 hand, when we are talking about the function, our interest is that we
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3228 will substitute a number for the word @var{number}. To keep this
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3229 distinction clear, we use different typography for the two
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3230 circumstances. When we talk about this function, or about how it works,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3231 we refer to this number by writing @var{number}. In the function
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3232 itself, we refer to it by writing @code{number}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3233 @end ignore
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3234
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3235 The argument list is followed by the documentation string that
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3236 describes the function. This is what you see when you type
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3237 @w{@kbd{C-h f}} and the name of a function. Incidentally, when you
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3238 write a documentation string like this, you should make the first line
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3239 a complete sentence since some commands, such as @code{apropos}, print
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3240 only the first line of a multi-line documentation string. Also, you
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3241 should not indent the second line of a documentation string, if you
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3242 have one, because that looks odd when you use @kbd{C-h f}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3243 (@code{describe-function}). The documentation string is optional, but
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3244 it is so useful, it should be included in almost every function you
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3245 write.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3246
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3247 @findex * @r{(multiplication)}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3248 The third line of the example consists of the body of the function
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3249 definition. (Most functions' definitions, of course, are longer than
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3250 this.) In this function, the body is the list, @code{(* 7 number)}, which
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3251 says to multiply the value of @var{number} by 7. (In Emacs Lisp,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3252 @code{*} is the function for multiplication, just as @code{+} is the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3253 function for addition.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3254
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3255 When you use the @code{multiply-by-seven} function, the argument
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3256 @code{number} evaluates to the actual number you want used. Here is an
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3257 example that shows how @code{multiply-by-seven} is used; but don't try
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3258 to evaluate this yet!
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3259
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3260 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3261 (multiply-by-seven 3)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3262 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3263
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3264 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3265 The symbol @code{number}, specified in the function definition in the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3266 next section, is given or ``bound to'' the value 3 in the actual use of
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3267 the function. Note that although @code{number} was inside parentheses
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3268 in the function definition, the argument passed to the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3269 @code{multiply-by-seven} function is not in parentheses. The
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3270 parentheses are written in the function definition so the computer can
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3271 figure out where the argument list ends and the rest of the function
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3272 definition begins.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3273
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3274 If you evaluate this example, you are likely to get an error message.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3275 (Go ahead, try it!) This is because we have written the function
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3276 definition, but not yet told the computer about the definition---we have
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3277 not yet installed (or `loaded') the function definition in Emacs.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3278 Installing a function is the process that tells the Lisp interpreter the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3279 definition of the function. Installation is described in the next
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3280 section.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3281
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3282 @node Install, Interactive, defun, Writing Defuns
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3283 @comment node-name, next, previous, up
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3284 @section Install a Function Definition
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3285 @cindex Install a Function Definition
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3286 @cindex Definition installation
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3287 @cindex Function definition installation
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3288
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3289 If you are reading this inside of Info in Emacs, you can try out the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3290 @code{multiply-by-seven} function by first evaluating the function
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3291 definition and then evaluating @code{(multiply-by-seven 3)}. A copy of
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3292 the function definition follows. Place the cursor after the last
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3293 parenthesis of the function definition and type @kbd{C-x C-e}. When you
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3294 do this, @code{multiply-by-seven} will appear in the echo area. (What
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3295 this means is that when a function definition is evaluated, the value it
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3296 returns is the name of the defined function.) At the same time, this
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3297 action installs the function definition.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3298
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3299 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3300 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3301 (defun multiply-by-seven (number)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3302 "Multiply NUMBER by seven."
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3303 (* 7 number))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3304 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3305 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3306
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3307 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3308 By evaluating this @code{defun}, you have just installed
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3309 @code{multiply-by-seven} in Emacs. The function is now just as much a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3310 part of Emacs as @code{forward-word} or any other editing function you
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3311 use. (@code{multiply-by-seven} will stay installed until you quit
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3312 Emacs. To reload code automatically whenever you start Emacs, see
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3313 @ref{Permanent Installation, , Installing Code Permanently}.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3314
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3315 @menu
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3316 * Effect of installation::
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3317 * Change a defun:: How to change a function definition.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3318 @end menu
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3319
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3320 @node Effect of installation, Change a defun, Install, Install
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3321 @ifnottex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3322 @unnumberedsubsec The effect of installation
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3323 @end ifnottex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3324
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3325 You can see the effect of installing @code{multiply-by-seven} by
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3326 evaluating the following sample. Place the cursor after the following
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3327 expression and type @kbd{C-x C-e}. The number 21 will appear in the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3328 echo area.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3329
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3330 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3331 (multiply-by-seven 3)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3332 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3333
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3334 If you wish, you can read the documentation for the function by typing
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3335 @kbd{C-h f} (@code{describe-function}) and then the name of the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3336 function, @code{multiply-by-seven}. When you do this, a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3337 @file{*Help*} window will appear on your screen that says:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3338
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3339 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3340 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3341 multiply-by-seven is a Lisp function.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3342 (multiply-by-seven NUMBER)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3343
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3344 Multiply NUMBER by seven.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3345 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3346 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3347
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3348 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3349 (To return to a single window on your screen, type @kbd{C-x 1}.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3350
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3351 @node Change a defun, , Effect of installation, Install
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3352 @comment node-name, next, previous, up
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3353 @subsection Change a Function Definition
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3354 @cindex Changing a function definition
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3355 @cindex Function definition, how to change
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3356 @cindex Definition, how to change
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3357
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3358 If you want to change the code in @code{multiply-by-seven}, just rewrite
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3359 it. To install the new version in place of the old one, evaluate the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3360 function definition again. This is how you modify code in Emacs. It is
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3361 very simple.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3362
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3363 As an example, you can change the @code{multiply-by-seven} function to
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3364 add the number to itself seven times instead of multiplying the number
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3365 by seven. It produces the same answer, but by a different path. At
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3366 the same time, we will add a comment to the code; a comment is text
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3367 that the Lisp interpreter ignores, but that a human reader may find
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3368 useful or enlightening. The comment is that this is the ``second
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3369 version''.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3370
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3371 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3372 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3373 (defun multiply-by-seven (number) ; @r{Second version.}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3374 "Multiply NUMBER by seven."
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3375 (+ number number number number number number number))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3376 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3377 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3378
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3379 @cindex Comments in Lisp code
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3380 The comment follows a semicolon, @samp{;}. In Lisp, everything on a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3381 line that follows a semicolon is a comment. The end of the line is the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3382 end of the comment. To stretch a comment over two or more lines, begin
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3383 each line with a semicolon.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3384
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3385 @xref{Beginning a .emacs File, , Beginning a @file{.emacs}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3386 File}, and @ref{Comments, , Comments, elisp, The GNU Emacs Lisp
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3387 Reference Manual}, for more about comments.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3388
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3389 You can install this version of the @code{multiply-by-seven} function by
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3390 evaluating it in the same way you evaluated the first function: place
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3391 the cursor after the last parenthesis and type @kbd{C-x C-e}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3392
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3393 In summary, this is how you write code in Emacs Lisp: you write a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3394 function; install it; test it; and then make fixes or enhancements and
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3395 install it again.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3396
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3397 @node Interactive, Interactive Options, Install, Writing Defuns
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3398 @comment node-name, next, previous, up
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3399 @section Make a Function Interactive
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3400 @cindex Interactive functions
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3401 @findex interactive
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3402
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3403 You make a function interactive by placing a list that begins with
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3404 the special form @code{interactive} immediately after the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3405 documentation. A user can invoke an interactive function by typing
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3406 @kbd{M-x} and then the name of the function; or by typing the keys to
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3407 which it is bound, for example, by typing @kbd{C-n} for
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3408 @code{next-line} or @kbd{C-x h} for @code{mark-whole-buffer}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3409
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3410 Interestingly, when you call an interactive function interactively,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3411 the value returned is not automatically displayed in the echo area.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3412 This is because you often call an interactive function for its side
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3413 effects, such as moving forward by a word or line, and not for the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3414 value returned. If the returned value were displayed in the echo area
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3415 each time you typed a key, it would be very distracting.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3416
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3417 @menu
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3418 * Interactive multiply-by-seven:: An overview.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3419 * multiply-by-seven in detail:: The interactive version.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3420 @end menu
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3421
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3422 @node Interactive multiply-by-seven, multiply-by-seven in detail, Interactive, Interactive
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3423 @ifnottex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3424 @unnumberedsubsec An Interactive @code{multiply-by-seven}, An Overview
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3425 @end ifnottex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3426
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3427 Both the use of the special form @code{interactive} and one way to
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3428 display a value in the echo area can be illustrated by creating an
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3429 interactive version of @code{multiply-by-seven}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3430
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3431 @need 1250
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3432 Here is the code:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3433
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3434 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3435 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3436 (defun multiply-by-seven (number) ; @r{Interactive version.}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3437 "Multiply NUMBER by seven."
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3438 (interactive "p")
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3439 (message "The result is %d" (* 7 number)))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3440 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3441 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3442
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3443 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3444 You can install this code by placing your cursor after it and typing
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3445 @kbd{C-x C-e}. The name of the function will appear in your echo area.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3446 Then, you can use this code by typing @kbd{C-u} and a number and then
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3447 typing @kbd{M-x multiply-by-seven} and pressing @key{RET}. The phrase
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3448 @samp{The result is @dots{}} followed by the product will appear in the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3449 echo area.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3450
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3451 Speaking more generally, you invoke a function like this in either of two
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3452 ways:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3453
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3454 @enumerate
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3455 @item
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3456 By typing a prefix argument that contains the number to be passed, and
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3457 then typing @kbd{M-x} and the name of the function, as with
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3458 @kbd{C-u 3 M-x forward-sentence}; or,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3459
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3460 @item
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3461 By typing whatever key or keychord the function is bound to, as with
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3462 @kbd{C-u 3 M-e}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3463 @end enumerate
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3464
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3465 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3466 Both the examples just mentioned work identically to move point forward
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3467 three sentences. (Since @code{multiply-by-seven} is not bound to a key,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3468 it could not be used as an example of key binding.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3469
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3470 (@xref{Keybindings, , Some Keybindings}, to learn how to bind a command
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3471 to a key.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3472
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3473 A prefix argument is passed to an interactive function by typing the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3474 @key{META} key followed by a number, for example, @kbd{M-3 M-e}, or by
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3475 typing @kbd{C-u} and then a number, for example, @kbd{C-u 3 M-e} (if you
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3476 type @kbd{C-u} without a number, it defaults to 4).
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3477
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3478 @node multiply-by-seven in detail, , Interactive multiply-by-seven, Interactive
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3479 @comment node-name, next, previous, up
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3480 @subsection An Interactive @code{multiply-by-seven}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3481
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3482 Let's look at the use of the special form @code{interactive} and then at
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3483 the function @code{message} in the interactive version of
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3484 @code{multiply-by-seven}. You will recall that the function definition
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3485 looks like this:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3486
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3487 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3488 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3489 (defun multiply-by-seven (number) ; @r{Interactive version.}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3490 "Multiply NUMBER by seven."
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3491 (interactive "p")
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3492 (message "The result is %d" (* 7 number)))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3493 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3494 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3495
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3496 In this function, the expression, @code{(interactive "p")}, is a list of
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3497 two elements. The @code{"p"} tells Emacs to pass the prefix argument to
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3498 the function and use its value for the argument of the function.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3499
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3500 @need 1000
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3501 The argument will be a number. This means that the symbol
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3502 @code{number} will be bound to a number in the line:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3503
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3504 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3505 (message "The result is %d" (* 7 number))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3506 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3507
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3508 @need 1250
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3509 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3510 For example, if your prefix argument is 5, the Lisp interpreter will
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3511 evaluate the line as if it were:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3512
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3513 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3514 (message "The result is %d" (* 7 5))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3515 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3516
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3517 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3518 (If you are reading this in GNU Emacs, you can evaluate this expression
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3519 yourself.) First, the interpreter will evaluate the inner list, which
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3520 is @code{(* 7 5)}. This returns a value of 35. Next, it
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3521 will evaluate the outer list, passing the values of the second and
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3522 subsequent elements of the list to the function @code{message}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3523
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3524 As we have seen, @code{message} is an Emacs Lisp function especially
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3525 designed for sending a one line message to a user. (@xref{message, ,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3526 The @code{message} function}.) In summary, the @code{message}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3527 function prints its first argument in the echo area as is, except for
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3528 occurrences of @samp{%d} or @samp{%s} (and various other %-sequences
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3529 which we have not mentioned). When it sees a control sequence, the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3530 function looks to the second or subsequent arguments and prints the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3531 value of the argument in the location in the string where the control
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3532 sequence is located.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3533
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3534 In the interactive @code{multiply-by-seven} function, the control string
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3535 is @samp{%d}, which requires a number, and the value returned by
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3536 evaluating @code{(* 7 5)} is the number 35. Consequently, the number 35
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3537 is printed in place of the @samp{%d} and the message is @samp{The result
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3538 is 35}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3539
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3540 (Note that when you call the function @code{multiply-by-seven}, the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3541 message is printed without quotes, but when you call @code{message}, the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3542 text is printed in double quotes. This is because the value returned by
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3543 @code{message} is what appears in the echo area when you evaluate an
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3544 expression whose first element is @code{message}; but when embedded in a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3545 function, @code{message} prints the text as a side effect without
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3546 quotes.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3547
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3548 @node Interactive Options, Permanent Installation, Interactive, Writing Defuns
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3549 @comment node-name, next, previous, up
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3550 @section Different Options for @code{interactive}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3551 @cindex Options for @code{interactive}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3552 @cindex Interactive options
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3553
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3554 In the example, @code{multiply-by-seven} used @code{"p"} as the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3555 argument to @code{interactive}. This argument told Emacs to interpret
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3556 your typing either @kbd{C-u} followed by a number or @key{META}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3557 followed by a number as a command to pass that number to the function
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3558 as its argument. Emacs has more than twenty characters predefined for
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3559 use with @code{interactive}. In almost every case, one of these
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3560 options will enable you to pass the right information interactively to
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3561 a function. (@xref{Interactive Codes, , Code Characters for
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3562 @code{interactive}, elisp, The GNU Emacs Lisp Reference Manual}.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3563
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3564 @need 1250
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3565 Consider the function @code{zap-to-char}. Its interactive expression
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3566 is
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3567
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3568 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3569 (interactive "p\ncZap to char: ")
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3570 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3571
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3572 The first part of the argument to @code{interactive} is @samp{p}, with
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3573 which you are already familiar. This argument tells Emacs to
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3574 interpret a `prefix', as a number to be passed to the function. You
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3575 can specify a prefix either by typing @kbd{C-u} followed by a number
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3576 or by typing @key{META} followed by a number. The prefix is the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3577 number of specified characters. Thus, if your prefix is three and the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3578 specified character is @samp{x}, then you will delete all the text up
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3579 to and including the third next @samp{x}. If you do not set a prefix,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3580 then you delete all the text up to and including the specified
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3581 character, but no more.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3582
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3583 The @samp{c} tells the function the name of the character to which to delete.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3584
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3585 More formally, a function with two or more arguments can have
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3586 information passed to each argument by adding parts to the string that
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3587 follows @code{interactive}. When you do this, the information is
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3588 passed to each argument in the same order it is specified in the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3589 @code{interactive} list. In the string, each part is separated from
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3590 the next part by a @samp{\n}, which is a newline. For example, you
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3591 can follow @samp{p} with a @samp{\n} and an @samp{cZap to char:@: }.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3592 This causes Emacs to pass the value of the prefix argument (if there
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3593 is one) and the character.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3594
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3595 In this case, the function definition looks like the following, where
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3596 @code{arg} and @code{char} are the symbols to which @code{interactive}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3597 binds the prefix argument and the specified character:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3598
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3599 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3600 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3601 (defun @var{name-of-function} (arg char)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3602 "@var{documentation}@dots{}"
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3603 (interactive "p\ncZap to char: ")
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3604 @var{body-of-function}@dots{})
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3605 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3606 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3607
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3608 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3609 (The space after the colon in the prompt makes it look better when you
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3610 are prompted. @xref{copy-to-buffer, , The Definition of
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3611 @code{copy-to-buffer}}, for an example.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3612
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3613 When a function does not take arguments, @code{interactive} does not
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3614 require any. Such a function contains the simple expression
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3615 @code{(interactive)}. The @code{mark-whole-buffer} function is like
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3616 this.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3617
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3618 Alternatively, if the special letter-codes are not right for your
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3619 application, you can pass your own arguments to @code{interactive} as
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3620 a list.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3621
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3622 @xref{append-to-buffer, , The Definition of @code{append-to-buffer}},
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3623 for an example. @xref{Using Interactive, , Using @code{Interactive},
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3624 elisp, The GNU Emacs Lisp Reference Manual}, for a more complete
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3625 explanation about this technique.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3626
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3627 @node Permanent Installation, let, Interactive Options, Writing Defuns
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3628 @comment node-name, next, previous, up
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3629 @section Install Code Permanently
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3630 @cindex Install code permanently
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3631 @cindex Permanent code installation
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3632 @cindex Code installation
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3633
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3634 When you install a function definition by evaluating it, it will stay
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3635 installed until you quit Emacs. The next time you start a new session
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3636 of Emacs, the function will not be installed unless you evaluate the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3637 function definition again.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3638
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3639 At some point, you may want to have code installed automatically
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3640 whenever you start a new session of Emacs. There are several ways of
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3641 doing this:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3642
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3643 @itemize @bullet
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3644 @item
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3645 If you have code that is just for yourself, you can put the code for the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3646 function definition in your @file{.emacs} initialization file. When you
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3647 start Emacs, your @file{.emacs} file is automatically evaluated and all
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3648 the function definitions within it are installed.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3649 @xref{Emacs Initialization, , Your @file{.emacs} File}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3650
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3651 @item
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3652 Alternatively, you can put the function definitions that you want
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3653 installed in one or more files of their own and use the @code{load}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3654 function to cause Emacs to evaluate and thereby install each of the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3655 functions in the files.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3656 @xref{Loading Files, , Loading Files}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3657
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3658 @item
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3659 Thirdly, if you have code that your whole site will use, it is usual
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3660 to put it in a file called @file{site-init.el} that is loaded when
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3661 Emacs is built. This makes the code available to everyone who uses
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3662 your machine. (See the @file{INSTALL} file that is part of the Emacs
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3663 distribution.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3664 @end itemize
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3665
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3666 Finally, if you have code that everyone who uses Emacs may want, you
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3667 can post it on a computer network or send a copy to the Free Software
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3668 Foundation. (When you do this, please license the code and its
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3669 documentation under a license that permits other people to run, copy,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3670 study, modify, and redistribute the code and which protects you from
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3671 having your work taken from you.) If you send a copy of your code to
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3672 the Free Software Foundation, and properly protect yourself and
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3673 others, it may be included in the next release of Emacs. In large
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3674 part, this is how Emacs has grown over the past years, by donations.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3675
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3676 @node let, if, Permanent Installation, Writing Defuns
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3677 @comment node-name, next, previous, up
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3678 @section @code{let}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3679 @findex let
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3680
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3681 The @code{let} expression is a special form in Lisp that you will need
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3682 to use in most function definitions.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3683
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3684 @code{let} is used to attach or bind a symbol to a value in such a way
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3685 that the Lisp interpreter will not confuse the variable with a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3686 variable of the same name that is not part of the function.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3687
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3688 To understand why the @code{let} special form is necessary, consider
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3689 the situation in which you own a home that you generally refer to as
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3690 `the house', as in the sentence, ``The house needs painting.'' If you
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3691 are visiting a friend and your host refers to `the house', he is
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3692 likely to be referring to @emph{his} house, not yours, that is, to a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3693 different house.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3694
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3695 If your friend is referring to his house and you think he is referring
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3696 to your house, you may be in for some confusion. The same thing could
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3697 happen in Lisp if a variable that is used inside of one function has
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3698 the same name as a variable that is used inside of another function,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3699 and the two are not intended to refer to the same value. The
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3700 @code{let} special form prevents this kind of confusion.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3701
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3702 @menu
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3703 * Prevent confusion::
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3704 * Parts of let Expression::
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3705 * Sample let Expression::
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3706 * Uninitialized let Variables::
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3707 @end menu
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3708
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3709 @node Prevent confusion, Parts of let Expression, let, let
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3710 @ifnottex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3711 @unnumberedsubsec @code{let} Prevents Confusion
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3712 @end ifnottex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3713
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3714 @cindex @samp{local variable} defined
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3715 @cindex @samp{variable, local}, defined
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3716 The @code{let} special form prevents confusion. @code{let} creates a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3717 name for a @dfn{local variable} that overshadows any use of the same
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3718 name outside the @code{let} expression. This is like understanding
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3719 that whenever your host refers to `the house', he means his house, not
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3720 yours. (Symbols used in argument lists work the same way.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3721 @xref{defun, , The @code{defun} Special Form}.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3722
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3723 Local variables created by a @code{let} expression retain their value
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3724 @emph{only} within the @code{let} expression itself (and within
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3725 expressions called within the @code{let} expression); the local
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3726 variables have no effect outside the @code{let} expression.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3727
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3728 Another way to think about @code{let} is that it is like a @code{setq}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3729 that is temporary and local. The values set by @code{let} are
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3730 automatically undone when the @code{let} is finished. The setting
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3731 only affects expressions that are inside the bounds of the @code{let}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3732 expression. In computer science jargon, we would say ``the binding of
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3733 a symbol is visible only in functions called in the @code{let} form;
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3734 in Emacs Lisp, scoping is dynamic, not lexical.''
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3735
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3736 @code{let} can create more than one variable at once. Also,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3737 @code{let} gives each variable it creates an initial value, either a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3738 value specified by you, or @code{nil}. (In the jargon, this is called
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3739 `binding the variable to the value'.) After @code{let} has created
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3740 and bound the variables, it executes the code in the body of the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3741 @code{let}, and returns the value of the last expression in the body,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3742 as the value of the whole @code{let} expression. (`Execute' is a jargon
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3743 term that means to evaluate a list; it comes from the use of the word
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3744 meaning `to give practical effect to' (@cite{Oxford English
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3745 Dictionary}). Since you evaluate an expression to perform an action,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3746 `execute' has evolved as a synonym to `evaluate'.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3747
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3748 @node Parts of let Expression, Sample let Expression, Prevent confusion, let
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3749 @comment node-name, next, previous, up
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3750 @subsection The Parts of a @code{let} Expression
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3751 @cindex @code{let} expression, parts of
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3752 @cindex Parts of @code{let} expression
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3753
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3754 @cindex @samp{varlist} defined
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3755 A @code{let} expression is a list of three parts. The first part is
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3756 the symbol @code{let}. The second part is a list, called a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3757 @dfn{varlist}, each element of which is either a symbol by itself or a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3758 two-element list, the first element of which is a symbol. The third
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3759 part of the @code{let} expression is the body of the @code{let}. The
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3760 body usually consists of one or more lists.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3761
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3762 @need 800
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3763 A template for a @code{let} expression looks like this:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3764
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3765 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3766 (let @var{varlist} @var{body}@dots{})
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3767 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3768
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3769 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3770 The symbols in the varlist are the variables that are given initial
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3771 values by the @code{let} special form. Symbols by themselves are given
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3772 the initial value of @code{nil}; and each symbol that is the first
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3773 element of a two-element list is bound to the value that is returned
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3774 when the Lisp interpreter evaluates the second element.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3775
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3776 Thus, a varlist might look like this: @code{(thread (needles 3))}. In
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3777 this case, in a @code{let} expression, Emacs binds the symbol
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3778 @code{thread} to an initial value of @code{nil}, and binds the symbol
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3779 @code{needles} to an initial value of 3.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3780
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3781 When you write a @code{let} expression, what you do is put the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3782 appropriate expressions in the slots of the @code{let} expression
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3783 template.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3784
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3785 If the varlist is composed of two-element lists, as is often the case,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3786 the template for the @code{let} expression looks like this:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3787
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3788 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3789 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3790 (let ((@var{variable} @var{value})
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3791 (@var{variable} @var{value})
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3792 @dots{})
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3793 @var{body}@dots{})
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3794 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3795 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3796
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3797 @node Sample let Expression, Uninitialized let Variables, Parts of let Expression, let
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3798 @comment node-name, next, previous, up
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3799 @subsection Sample @code{let} Expression
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3800 @cindex Sample @code{let} expression
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3801 @cindex @code{let} expression sample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3802
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3803 The following expression creates and gives initial values
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3804 to the two variables @code{zebra} and @code{tiger}. The body of the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3805 @code{let} expression is a list which calls the @code{message} function.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3806
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3807 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3808 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3809 (let ((zebra 'stripes)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3810 (tiger 'fierce))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3811 (message "One kind of animal has %s and another is %s."
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3812 zebra tiger))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3813 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3814 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3815
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3816 Here, the varlist is @code{((zebra 'stripes) (tiger 'fierce))}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3817
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3818 The two variables are @code{zebra} and @code{tiger}. Each variable is
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3819 the first element of a two-element list and each value is the second
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3820 element of its two-element list. In the varlist, Emacs binds the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3821 variable @code{zebra} to the value @code{stripes}@footnote{According
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3822 to Jared Diamond in @cite{Guns, Germs, and Steel}, ``@dots{} zebras
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3823 become impossibly dangerous as they grow older'' but the claim here is
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3824 that they do not become fierce like a tiger. (1997, W. W. Norton and
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3825 Co., ISBN 0-393-03894-2, page 171)}, and binds the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3826 variable @code{tiger} to the value @code{fierce}. In this example,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3827 both values are symbols preceded by a quote. The values could just as
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3828 well have been another list or a string. The body of the @code{let}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3829 follows after the list holding the variables. In this example, the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3830 body is a list that uses the @code{message} function to print a string
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3831 in the echo area.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3832
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3833 @need 1500
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3834 You may evaluate the example in the usual fashion, by placing the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3835 cursor after the last parenthesis and typing @kbd{C-x C-e}. When you do
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3836 this, the following will appear in the echo area:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3837
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3838 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3839 "One kind of animal has stripes and another is fierce."
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3840 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3841
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3842 As we have seen before, the @code{message} function prints its first
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3843 argument, except for @samp{%s}. In this example, the value of the variable
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3844 @code{zebra} is printed at the location of the first @samp{%s} and the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3845 value of the variable @code{tiger} is printed at the location of the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3846 second @samp{%s}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3847
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3848 @node Uninitialized let Variables, , Sample let Expression, let
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3849 @comment node-name, next, previous, up
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3850 @subsection Uninitialized Variables in a @code{let} Statement
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3851 @cindex Uninitialized @code{let} variables
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3852 @cindex @code{let} variables uninitialized
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3853
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3854 If you do not bind the variables in a @code{let} statement to specific
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3855 initial values, they will automatically be bound to an initial value of
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3856 @code{nil}, as in the following expression:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3857
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3858 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3859 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3860 (let ((birch 3)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3861 pine
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3862 fir
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3863 (oak 'some))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3864 (message
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3865 "Here are %d variables with %s, %s, and %s value."
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3866 birch pine fir oak))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3867 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3868 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3869
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3870 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3871 Here, the varlist is @code{((birch 3) pine fir (oak 'some))}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3872
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3873 @need 1250
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3874 If you evaluate this expression in the usual way, the following will
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3875 appear in your echo area:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3876
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3877 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3878 "Here are 3 variables with nil, nil, and some value."
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3879 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3880
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3881 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3882 In this example, Emacs binds the symbol @code{birch} to the number 3,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3883 binds the symbols @code{pine} and @code{fir} to @code{nil}, and binds
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3884 the symbol @code{oak} to the value @code{some}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3885
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3886 Note that in the first part of the @code{let}, the variables @code{pine}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3887 and @code{fir} stand alone as atoms that are not surrounded by
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3888 parentheses; this is because they are being bound to @code{nil}, the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3889 empty list. But @code{oak} is bound to @code{some} and so is a part of
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3890 the list @code{(oak 'some)}. Similarly, @code{birch} is bound to the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3891 number 3 and so is in a list with that number. (Since a number
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3892 evaluates to itself, the number does not need to be quoted. Also, the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3893 number is printed in the message using a @samp{%d} rather than a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3894 @samp{%s}.) The four variables as a group are put into a list to
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3895 delimit them from the body of the @code{let}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3896
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3897 @node if, else, let, Writing Defuns
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3898 @comment node-name, next, previous, up
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3899 @section The @code{if} Special Form
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3900 @findex if
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3901 @cindex Conditional with @code{if}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3902
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3903 A third special form, in addition to @code{defun} and @code{let}, is the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3904 conditional @code{if}. This form is used to instruct the computer to
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3905 make decisions. You can write function definitions without using
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3906 @code{if}, but it is used often enough, and is important enough, to be
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3907 included here. It is used, for example, in the code for the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3908 function @code{beginning-of-buffer}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3909
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3910 The basic idea behind an @code{if}, is that ``@emph{if} a test is true,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3911 @emph{then} an expression is evaluated.'' If the test is not true, the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3912 expression is not evaluated. For example, you might make a decision
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3913 such as, ``if it is warm and sunny, then go to the beach!''
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3914
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3915 @menu
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3916 * if in more detail::
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3917 * type-of-animal in detail:: An example of an @code{if} expression.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3918 @end menu
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3919
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3920 @node if in more detail, type-of-animal in detail, if, if
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3921 @ifnottex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3922 @unnumberedsubsec @code{if} in more detail
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3923 @end ifnottex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3924
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3925 @cindex @samp{if-part} defined
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3926 @cindex @samp{then-part} defined
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3927 An @code{if} expression written in Lisp does not use the word `then';
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3928 the test and the action are the second and third elements of the list
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3929 whose first element is @code{if}. Nonetheless, the test part of an
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3930 @code{if} expression is often called the @dfn{if-part} and the second
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3931 argument is often called the @dfn{then-part}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3932
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3933 Also, when an @code{if} expression is written, the true-or-false-test
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3934 is usually written on the same line as the symbol @code{if}, but the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3935 action to carry out if the test is true, the ``then-part'', is written
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3936 on the second and subsequent lines. This makes the @code{if}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3937 expression easier to read.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3938
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3939 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3940 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3941 (if @var{true-or-false-test}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3942 @var{action-to-carry-out-if-test-is-true})
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3943 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3944 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3945
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3946 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3947 The true-or-false-test will be an expression that
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3948 is evaluated by the Lisp interpreter.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3949
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3950 Here is an example that you can evaluate in the usual manner. The test
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3951 is whether the number 5 is greater than the number 4. Since it is, the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3952 message @samp{5 is greater than 4!} will be printed.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3953
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3954 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3955 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3956 (if (> 5 4) ; @r{if-part}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3957 (message "5 is greater than 4!")) ; @r{then-part}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3958 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3959 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3960
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3961 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3962 (The function @code{>} tests whether its first argument is greater than
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3963 its second argument and returns true if it is.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3964 @findex > (greater than)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3965
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3966 Of course, in actual use, the test in an @code{if} expression will not
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3967 be fixed for all time as it is by the expression @code{(> 5 4)}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3968 Instead, at least one of the variables used in the test will be bound to
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3969 a value that is not known ahead of time. (If the value were known ahead
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3970 of time, we would not need to run the test!)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3971
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3972 For example, the value may be bound to an argument of a function
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3973 definition. In the following function definition, the character of the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3974 animal is a value that is passed to the function. If the value bound to
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3975 @code{characteristic} is @code{fierce}, then the message, @samp{It's a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3976 tiger!} will be printed; otherwise, @code{nil} will be returned.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3977
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3978 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3979 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3980 (defun type-of-animal (characteristic)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3981 "Print message in echo area depending on CHARACTERISTIC.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3982 If the CHARACTERISTIC is the symbol `fierce',
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3983 then warn of a tiger."
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3984 (if (equal characteristic 'fierce)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3985 (message "It's a tiger!")))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3986 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3987 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3988
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3989 @need 1500
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3990 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3991 If you are reading this inside of GNU Emacs, you can evaluate the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3992 function definition in the usual way to install it in Emacs, and then you
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3993 can evaluate the following two expressions to see the results:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3994
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3995 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3996 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3997 (type-of-animal 'fierce)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3998
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3999 (type-of-animal 'zebra)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4000
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4001 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4002 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4003
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4004 @c Following sentences rewritten to prevent overfull hbox.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4005 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4006 When you evaluate @code{(type-of-animal 'fierce)}, you will see the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4007 following message printed in the echo area: @code{"It's a tiger!"}; and
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4008 when you evaluate @code{(type-of-animal 'zebra)} you will see @code{nil}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4009 printed in the echo area.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4010
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4011 @node type-of-animal in detail, , if in more detail, if
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4012 @comment node-name, next, previous, up
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4013 @subsection The @code{type-of-animal} Function in Detail
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4014
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4015 Let's look at the @code{type-of-animal} function in detail.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4016
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4017 The function definition for @code{type-of-animal} was written by filling
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4018 the slots of two templates, one for a function definition as a whole, and
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4019 a second for an @code{if} expression.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4020
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4021 @need 1250
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4022 The template for every function that is not interactive is:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4023
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4024 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4025 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4026 (defun @var{name-of-function} (@var{argument-list})
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4027 "@var{documentation}@dots{}"
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4028 @var{body}@dots{})
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4029 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4030 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4031
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4032 @need 800
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4033 The parts of the function that match this template look like this:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4034
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4035 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4036 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4037 (defun type-of-animal (characteristic)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4038 "Print message in echo area depending on CHARACTERISTIC.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4039 If the CHARACTERISTIC is the symbol `fierce',
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4040 then warn of a tiger."
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4041 @var{body: the} @code{if} @var{expression})
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4042 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4043 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4044
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4045 The name of function is @code{type-of-animal}; it is passed the value
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4046 of one argument. The argument list is followed by a multi-line
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4047 documentation string. The documentation string is included in the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4048 example because it is a good habit to write documentation string for
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4049 every function definition. The body of the function definition
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4050 consists of the @code{if} expression.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4051
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4052 @need 800
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4053 The template for an @code{if} expression looks like this:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4054
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4055 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4056 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4057 (if @var{true-or-false-test}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4058 @var{action-to-carry-out-if-the-test-returns-true})
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4059 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4060 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4061
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4062 @need 1250
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4063 In the @code{type-of-animal} function, the code for the @code{if}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4064 looks like this:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4065
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4066 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4067 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4068 (if (equal characteristic 'fierce)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4069 (message "It's a tiger!")))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4070 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4071 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4072
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4073 @need 800
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4074 Here, the true-or-false-test is the expression:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4075
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4076 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4077 (equal characteristic 'fierce)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4078 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4079
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4080 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4081 In Lisp, @code{equal} is a function that determines whether its first
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4082 argument is equal to its second argument. The second argument is the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4083 quoted symbol @code{'fierce} and the first argument is the value of the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4084 symbol @code{characteristic}---in other words, the argument passed to
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4085 this function.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4086
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4087 In the first exercise of @code{type-of-animal}, the argument
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4088 @code{fierce} is passed to @code{type-of-animal}. Since @code{fierce}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4089 is equal to @code{fierce}, the expression, @code{(equal characteristic
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4090 'fierce)}, returns a value of true. When this happens, the @code{if}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4091 evaluates the second argument or then-part of the @code{if}:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4092 @code{(message "It's tiger!")}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4093
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4094 On the other hand, in the second exercise of @code{type-of-animal}, the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4095 argument @code{zebra} is passed to @code{type-of-animal}. @code{zebra}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4096 is not equal to @code{fierce}, so the then-part is not evaluated and
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4097 @code{nil} is returned by the @code{if} expression.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4098
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4099 @node else, Truth & Falsehood, if, Writing Defuns
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4100 @comment node-name, next, previous, up
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4101 @section If--then--else Expressions
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4102 @cindex Else
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4103
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4104 An @code{if} expression may have an optional third argument, called
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4105 the @dfn{else-part}, for the case when the true-or-false-test returns
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4106 false. When this happens, the second argument or then-part of the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4107 overall @code{if} expression is @emph{not} evaluated, but the third or
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4108 else-part @emph{is} evaluated. You might think of this as the cloudy
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4109 day alternative for the decision ``if it is warm and sunny, then go to
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4110 the beach, else read a book!''.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4111
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4112 The word ``else'' is not written in the Lisp code; the else-part of an
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4113 @code{if} expression comes after the then-part. In the written Lisp, the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4114 else-part is usually written to start on a line of its own and is
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4115 indented less than the then-part:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4116
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4117 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4118 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4119 (if @var{true-or-false-test}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4120 @var{action-to-carry-out-if-the-test-returns-true}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4121 @var{action-to-carry-out-if-the-test-returns-false})
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4122 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4123 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4124
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4125 For example, the following @code{if} expression prints the message @samp{4
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4126 is not greater than 5!} when you evaluate it in the usual way:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4127
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4128 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4129 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4130 (if (> 4 5) ; @r{if-part}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4131 (message "4 falsely greater than 5!") ; @r{then-part}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4132 (message "4 is not greater than 5!")) ; @r{else-part}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4133 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4134 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4135
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4136 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4137 Note that the different levels of indentation make it easy to
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4138 distinguish the then-part from the else-part. (GNU Emacs has several
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4139 commands that automatically indent @code{if} expressions correctly.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4140 @xref{Typing Lists, , GNU Emacs Helps You Type Lists}.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4141
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4142 We can extend the @code{type-of-animal} function to include an
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4143 else-part by simply incorporating an additional part to the @code{if}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4144 expression.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4145
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4146 @need 1500
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4147 You can see the consequences of doing this if you evaluate the following
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4148 version of the @code{type-of-animal} function definition to install it
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4149 and then evaluate the two subsequent expressions to pass different
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4150 arguments to the function.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4151
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4152 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4153 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4154 (defun type-of-animal (characteristic) ; @r{Second version.}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4155 "Print message in echo area depending on CHARACTERISTIC.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4156 If the CHARACTERISTIC is the symbol `fierce',
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4157 then warn of a tiger;
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4158 else say it's not fierce."
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4159 (if (equal characteristic 'fierce)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4160 (message "It's a tiger!")
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4161 (message "It's not fierce!")))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4162 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4163 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4164 @sp 1
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4165
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4166 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4167 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4168 (type-of-animal 'fierce)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4169
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4170 (type-of-animal 'zebra)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4171
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4172 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4173 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4174
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4175 @c Following sentence rewritten to prevent overfull hbox.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4176 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4177 When you evaluate @code{(type-of-animal 'fierce)}, you will see the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4178 following message printed in the echo area: @code{"It's a tiger!"}; but
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4179 when you evaluate @code{(type-of-animal 'zebra)}, you will see
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4180 @code{"It's not fierce!"}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4181
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4182 (Of course, if the @var{characteristic} were @code{ferocious}, the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4183 message @code{"It's not fierce!"} would be printed; and it would be
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4184 misleading! When you write code, you need to take into account the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4185 possibility that some such argument will be tested by the @code{if}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4186 and write your program accordingly.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4187
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4188 @node Truth & Falsehood, save-excursion, else, Writing Defuns
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4189 @comment node-name, next, previous, up
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4190 @section Truth and Falsehood in Emacs Lisp
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4191 @cindex Truth and falsehood in Emacs Lisp
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4192 @cindex Falsehood and truth in Emacs Lisp
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4193 @findex nil
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4194
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4195 There is an important aspect to the truth test in an @code{if}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4196 expression. So far, we have spoken of `true' and `false' as values of
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4197 predicates as if they were new kinds of Emacs Lisp objects. In fact,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4198 `false' is just our old friend @code{nil}. Anything else---anything
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4199 at all---is `true'.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4200
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4201 The expression that tests for truth is interpreted as @dfn{true}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4202 if the result of evaluating it is a value that is not @code{nil}. In
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4203 other words, the result of the test is considered true if the value
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4204 returned is a number such as 47, a string such as @code{"hello"}, or a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4205 symbol (other than @code{nil}) such as @code{flowers}, or a list (so
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4206 long as it is not empty), or even a buffer!
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4207
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4208 @menu
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4209 * nil explained:: @code{nil} has two meanings.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4210 @end menu
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4211
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4212 @node nil explained, , Truth & Falsehood, Truth & Falsehood
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4213 @ifnottex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4214 @unnumberedsubsec An explanation of @code{nil}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4215 @end ifnottex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4216
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4217 Before illustrating a test for truth, we need an explanation of @code{nil}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4218
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4219 In Emacs Lisp, the symbol @code{nil} has two meanings. First, it means the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4220 empty list. Second, it means false and is the value returned when a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4221 true-or-false-test tests false. @code{nil} can be written as an empty
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4222 list, @code{()}, or as @code{nil}. As far as the Lisp interpreter is
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4223 concerned, @code{()} and @code{nil} are the same. Humans, however, tend
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4224 to use @code{nil} for false and @code{()} for the empty list.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4225
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4226 In Emacs Lisp, any value that is not @code{nil}---is not the empty
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4227 list---is considered true. This means that if an evaluation returns
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4228 something that is not an empty list, an @code{if} expression will test
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4229 true. For example, if a number is put in the slot for the test, it
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4230 will be evaluated and will return itself, since that is what numbers
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4231 do when evaluated. In this conditional, the @code{if} expression will
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4232 test true. The expression tests false only when @code{nil}, an empty
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4233 list, is returned by evaluating the expression.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4234
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4235 You can see this by evaluating the two expressions in the following examples.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4236
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4237 In the first example, the number 4 is evaluated as the test in the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4238 @code{if} expression and returns itself; consequently, the then-part
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4239 of the expression is evaluated and returned: @samp{true} appears in
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4240 the echo area. In the second example, the @code{nil} indicates false;
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4241 consequently, the else-part of the expression is evaluated and
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4242 returned: @samp{false} appears in the echo area.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4243
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4244 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4245 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4246 (if 4
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4247 'true
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4248 'false)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4249 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4250
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4251 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4252 (if nil
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4253 'true
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4254 'false)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4255 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4256 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4257
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4258 @need 1250
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4259 Incidentally, if some other useful value is not available for a test that
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4260 returns true, then the Lisp interpreter will return the symbol @code{t}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4261 for true. For example, the expression @code{(> 5 4)} returns @code{t}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4262 when evaluated, as you can see by evaluating it in the usual way:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4263
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4264 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4265 (> 5 4)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4266 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4267
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4268 @need 1250
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4269 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4270 On the other hand, this function returns @code{nil} if the test is false.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4271
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4272 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4273 (> 4 5)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4274 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4275
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4276 @node save-excursion, Review, Truth & Falsehood, Writing Defuns
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4277 @comment node-name, next, previous, up
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4278 @section @code{save-excursion}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4279 @findex save-excursion
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4280 @cindex Region, what it is
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4281 @cindex Preserving point, mark, and buffer
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4282 @cindex Point, mark, buffer preservation
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4283 @findex point
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4284 @findex mark
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4285
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4286 The @code{save-excursion} function is the fourth and final special form
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4287 that we will discuss in this chapter.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4288
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4289 In Emacs Lisp programs used for editing, the @code{save-excursion}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4290 function is very common. It saves the location of point and mark,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4291 executes the body of the function, and then restores point and mark to
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4292 their previous positions if their locations were changed. Its primary
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4293 purpose is to keep the user from being surprised and disturbed by
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4294 unexpected movement of point or mark.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4295
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4296 @menu
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4297 * Point and mark:: A review of various locations.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4298 * Template for save-excursion::
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4299 @end menu
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4300
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4301 @node Point and mark, Template for save-excursion, save-excursion, save-excursion
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4302 @ifnottex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4303 @unnumberedsubsec Point and Mark
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4304 @end ifnottex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4305
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4306 Before discussing @code{save-excursion}, however, it may be useful
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4307 first to review what point and mark are in GNU Emacs. @dfn{Point} is
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4308 the current location of the cursor. Wherever the cursor
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4309 is, that is point. More precisely, on terminals where the cursor
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4310 appears to be on top of a character, point is immediately before the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4311 character. In Emacs Lisp, point is an integer. The first character in
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4312 a buffer is number one, the second is number two, and so on. The
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4313 function @code{point} returns the current position of the cursor as a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4314 number. Each buffer has its own value for point.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4315
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4316 The @dfn{mark} is another position in the buffer; its value can be set
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4317 with a command such as @kbd{C-@key{SPC}} (@code{set-mark-command}). If
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4318 a mark has been set, you can use the command @kbd{C-x C-x}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4319 (@code{exchange-point-and-mark}) to cause the cursor to jump to the mark
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4320 and set the mark to be the previous position of point. In addition, if
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4321 you set another mark, the position of the previous mark is saved in the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4322 mark ring. Many mark positions can be saved this way. You can jump the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4323 cursor to a saved mark by typing @kbd{C-u C-@key{SPC}} one or more
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4324 times.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4325
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4326 The part of the buffer between point and mark is called @dfn{the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4327 region}. Numerous commands work on the region, including
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4328 @code{center-region}, @code{count-lines-region}, @code{kill-region}, and
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4329 @code{print-region}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4330
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4331 The @code{save-excursion} special form saves the locations of point and
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4332 mark and restores those positions after the code within the body of the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4333 special form is evaluated by the Lisp interpreter. Thus, if point were
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4334 in the beginning of a piece of text and some code moved point to the end
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4335 of the buffer, the @code{save-excursion} would put point back to where
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4336 it was before, after the expressions in the body of the function were
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4337 evaluated.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4338
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4339 In Emacs, a function frequently moves point as part of its internal
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4340 workings even though a user would not expect this. For example,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4341 @code{count-lines-region} moves point. To prevent the user from being
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4342 bothered by jumps that are both unexpected and (from the user's point of
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4343 view) unnecessary, @code{save-excursion} is often used to keep point and
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4344 mark in the location expected by the user. The use of
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4345 @code{save-excursion} is good housekeeping.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4346
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4347 To make sure the house stays clean, @code{save-excursion} restores the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4348 values of point and mark even if something goes wrong in the code inside
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4349 of it (or, to be more precise and to use the proper jargon, ``in case of
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4350 abnormal exit''). This feature is very helpful.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4351
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4352 In addition to recording the values of point and mark,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4353 @code{save-excursion} keeps track of the current buffer, and restores
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4354 it, too. This means you can write code that will change the buffer and
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4355 have @code{save-excursion} switch you back to the original buffer.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4356 This is how @code{save-excursion} is used in @code{append-to-buffer}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4357 (@xref{append-to-buffer, , The Definition of @code{append-to-buffer}}.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4358
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4359 @node Template for save-excursion, , Point and mark, save-excursion
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4360 @comment node-name, next, previous, up
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4361 @subsection Template for a @code{save-excursion} Expression
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4362
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4363 @need 800
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4364 The template for code using @code{save-excursion} is simple:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4365
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4366 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4367 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4368 (save-excursion
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4369 @var{body}@dots{})
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4370 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4371 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4372
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4373 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4374 The body of the function is one or more expressions that will be
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4375 evaluated in sequence by the Lisp interpreter. If there is more than
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4376 one expression in the body, the value of the last one will be returned
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4377 as the value of the @code{save-excursion} function. The other
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4378 expressions in the body are evaluated only for their side effects; and
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4379 @code{save-excursion} itself is used only for its side effect (which
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4380 is restoring the positions of point and mark).
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4381
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4382 @need 1250
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4383 In more detail, the template for a @code{save-excursion} expression
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4384 looks like this:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4385
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4386 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4387 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4388 (save-excursion
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4389 @var{first-expression-in-body}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4390 @var{second-expression-in-body}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4391 @var{third-expression-in-body}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4392 @dots{}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4393 @var{last-expression-in-body})
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4394 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4395 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4396
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4397 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4398 An expression, of course, may be a symbol on its own or a list.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4399
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4400 In Emacs Lisp code, a @code{save-excursion} expression often occurs
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4401 within the body of a @code{let} expression. It looks like this:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4402
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4403 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4404 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4405 (let @var{varlist}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4406 (save-excursion
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4407 @var{body}@dots{}))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4408 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4409 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4410
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4411 @node Review, defun Exercises, save-excursion, Writing Defuns
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4412 @comment node-name, next, previous, up
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4413 @section Review
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4414
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4415 In the last few chapters we have introduced a fair number of functions
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4416 and special forms. Here they are described in brief, along with a few
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4417 similar functions that have not been mentioned yet.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4418
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4419 @table @code
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4420 @item eval-last-sexp
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4421 Evaluate the last symbolic expression before the current location of
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4422 point. The value is printed in the echo area unless the function is
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4423 invoked with an argument; in that case, the output is printed in the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4424 current buffer. This command is normally bound to @kbd{C-x C-e}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4425
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4426 @item defun
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4427 Define function. This special form has up to five parts: the name,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4428 a template for the arguments that will be passed to the function,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4429 documentation, an optional interactive declaration, and the body of the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4430 definition.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4431
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4432 @need 1250
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4433 For example, in an early version of Emacs, the function definition was
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4434 as follows. (It is slightly more complex now that it seeks the first
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4435 non-whitespace character rather than the first visible character.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4436
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4437 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4438 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4439 (defun back-to-indentation ()
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4440 "Move point to first visible character on line."
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4441 (interactive)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4442 (beginning-of-line 1)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4443 (skip-chars-forward " \t"))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4444 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4445 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4446
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4447 @ignore
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4448 In GNU Emacs 22,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4449
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4450 (defun backward-to-indentation (&optional arg)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4451 "Move backward ARG lines and position at first nonblank character."
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4452 (interactive "p")
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4453 (forward-line (- (or arg 1)))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4454 (skip-chars-forward " \t"))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4455
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4456 (defun back-to-indentation ()
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4457 "Move point to the first non-whitespace character on this line."
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4458 (interactive)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4459 (beginning-of-line 1)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4460 (skip-syntax-forward " " (line-end-position))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4461 ;; Move back over chars that have whitespace syntax but have the p flag.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4462 (backward-prefix-chars))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4463 @end ignore
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4464
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4465 @item interactive
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4466 Declare to the interpreter that the function can be used
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4467 interactively. This special form may be followed by a string with one
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4468 or more parts that pass the information to the arguments of the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4469 function, in sequence. These parts may also tell the interpreter to
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4470 prompt for information. Parts of the string are separated by
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4471 newlines, @samp{\n}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4472
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4473 @need 1000
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4474 Common code characters are:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4475
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4476 @table @code
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4477 @item b
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4478 The name of an existing buffer.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4479
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4480 @item f
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4481 The name of an existing file.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4482
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4483 @item p
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4484 The numeric prefix argument. (Note that this `p' is lower case.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4485
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4486 @item r
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4487 Point and the mark, as two numeric arguments, smallest first. This
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4488 is the only code letter that specifies two successive arguments
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4489 rather than one.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4490 @end table
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4491
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4492 @xref{Interactive Codes, , Code Characters for @samp{interactive},
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4493 elisp, The GNU Emacs Lisp Reference Manual}, for a complete list of
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4494 code characters.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4495
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4496 @item let
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4497 Declare that a list of variables is for use within the body of the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4498 @code{let} and give them an initial value, either @code{nil} or a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4499 specified value; then evaluate the rest of the expressions in the body
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4500 of the @code{let} and return the value of the last one. Inside the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4501 body of the @code{let}, the Lisp interpreter does not see the values of
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4502 the variables of the same names that are bound outside of the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4503 @code{let}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4504
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4505 @need 1250
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4506 For example,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4507
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4508 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4509 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4510 (let ((foo (buffer-name))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4511 (bar (buffer-size)))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4512 (message
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4513 "This buffer is %s and has %d characters."
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4514 foo bar))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4515 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4516 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4517
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4518 @item save-excursion
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4519 Record the values of point and mark and the current buffer before
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4520 evaluating the body of this special form. Restore the values of point
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4521 and mark and buffer afterward.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4522
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4523 @need 1250
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4524 For example,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4525
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4526 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4527 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4528 (message "We are %d characters into this buffer."
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4529 (- (point)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4530 (save-excursion
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4531 (goto-char (point-min)) (point))))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4532 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4533 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4534
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4535 @item if
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4536 Evaluate the first argument to the function; if it is true, evaluate
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4537 the second argument; else evaluate the third argument, if there is one.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4538
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4539 The @code{if} special form is called a @dfn{conditional}. There are
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4540 other conditionals in Emacs Lisp, but @code{if} is perhaps the most
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4541 commonly used.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4542
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4543 @need 1250
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4544 For example,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4545
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4546 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4547 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4548 (if (= 22 emacs-major-version)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4549 (message "This is version 22 Emacs")
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4550 (message "This is not version 22 Emacs"))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4551 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4552 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4553
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4554 @need 1250
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4555 @item <
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4556 @itemx >
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4557 @itemx <=
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4558 @itemx >=
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4559 The @code{<} function tests whether its first argument is smaller than
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4560 its second argument. A corresponding function, @code{>}, tests whether
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4561 the first argument is greater than the second. Likewise, @code{<=}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4562 tests whether the first argument is less than or equal to the second and
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4563 @code{>=} tests whether the first argument is greater than or equal to
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4564 the second. In all cases, both arguments must be numbers or markers
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4565 (markers indicate positions in buffers).
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4566
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4567 @need 800
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4568 @item =
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4569 The @code{=} function tests whether two arguments, both numbers or
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4570 markers, are equal.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4571
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4572 @need 1250
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4573 @item equal
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4574 @itemx eq
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4575 Test whether two objects are the same. @code{equal} uses one meaning
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4576 of the word `same' and @code{eq} uses another: @code{equal} returns
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4577 true if the two objects have a similar structure and contents, such as
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4578 two copies of the same book. On the other hand, @code{eq}, returns
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4579 true if both arguments are actually the same object.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4580 @findex equal
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4581 @findex eq
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4582
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4583 @need 1250
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4584 @item string<
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4585 @itemx string-lessp
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4586 @itemx string=
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4587 @itemx string-equal
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4588 The @code{string-lessp} function tests whether its first argument is
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4589 smaller than the second argument. A shorter, alternative name for the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4590 same function (a @code{defalias}) is @code{string<}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4591
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4592 The arguments to @code{string-lessp} must be strings or symbols; the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4593 ordering is lexicographic, so case is significant. The print names of
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4594 symbols are used instead of the symbols themselves.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4595
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4596 @cindex @samp{empty string} defined
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4597 An empty string, @samp{""}, a string with no characters in it, is
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4598 smaller than any string of characters.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4599
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4600 @code{string-equal} provides the corresponding test for equality. Its
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4601 shorter, alternative name is @code{string=}. There are no string test
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4602 functions that correspond to @var{>}, @code{>=}, or @code{<=}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4603
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4604 @item message
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4605 Print a message in the echo area. The first argument is a string that
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4606 can contain @samp{%s}, @samp{%d}, or @samp{%c} to print the value of
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4607 arguments that follow the string. The argument used by @samp{%s} must
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4608 be a string or a symbol; the argument used by @samp{%d} must be a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4609 number. The argument used by @samp{%c} must be an @sc{ascii} code
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4610 number; it will be printed as the character with that @sc{ascii} code.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4611 (Various other %-sequences have not been mentioned.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4612
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4613 @item setq
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4614 @itemx set
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4615 The @code{setq} function sets the value of its first argument to the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4616 value of the second argument. The first argument is automatically
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4617 quoted by @code{setq}. It does the same for succeeding pairs of
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4618 arguments. Another function, @code{set}, takes only two arguments and
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4619 evaluates both of them before setting the value returned by its first
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4620 argument to the value returned by its second argument.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4621
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4622 @item buffer-name
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4623 Without an argument, return the name of the buffer, as a string.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4624
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4625 @itemx buffer-file-name
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4626 Without an argument, return the name of the file the buffer is
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4627 visiting.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4628
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4629 @item current-buffer
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4630 Return the buffer in which Emacs is active; it may not be
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4631 the buffer that is visible on the screen.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4632
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4633 @item other-buffer
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4634 Return the most recently selected buffer (other than the buffer passed
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4635 to @code{other-buffer} as an argument and other than the current
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4636 buffer).
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4637
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4638 @item switch-to-buffer
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4639 Select a buffer for Emacs to be active in and display it in the current
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4640 window so users can look at it. Usually bound to @kbd{C-x b}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4641
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4642 @item set-buffer
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4643 Switch Emacs' attention to a buffer on which programs will run. Don't
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4644 alter what the window is showing.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4645
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4646 @item buffer-size
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4647 Return the number of characters in the current buffer.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4648
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4649 @item point
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4650 Return the value of the current position of the cursor, as an
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4651 integer counting the number of characters from the beginning of the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4652 buffer.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4653
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4654 @item point-min
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4655 Return the minimum permissible value of point in
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4656 the current buffer. This is 1, unless narrowing is in effect.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4657
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4658 @item point-max
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4659 Return the value of the maximum permissible value of point in the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4660 current buffer. This is the end of the buffer, unless narrowing is in
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4661 effect.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4662 @end table
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4663
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4664 @need 1500
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4665 @node defun Exercises, , Review, Writing Defuns
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4666 @section Exercises
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4667
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4668 @itemize @bullet
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4669 @item
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4670 Write a non-interactive function that doubles the value of its
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4671 argument, a number. Make that function interactive.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4672
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4673 @item
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4674 Write a function that tests whether the current value of
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4675 @code{fill-column} is greater than the argument passed to the function,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4676 and if so, prints an appropriate message.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4677 @end itemize
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4678
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4679 @node Buffer Walk Through, More Complex, Writing Defuns, Top
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4680 @comment node-name, next, previous, up
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4681 @chapter A Few Buffer--Related Functions
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4682
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4683 In this chapter we study in detail several of the functions used in GNU
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4684 Emacs. This is called a ``walk-through''. These functions are used as
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4685 examples of Lisp code, but are not imaginary examples; with the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4686 exception of the first, simplified function definition, these functions
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4687 show the actual code used in GNU Emacs. You can learn a great deal from
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4688 these definitions. The functions described here are all related to
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4689 buffers. Later, we will study other functions.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4690
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4691 @menu
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4692 * Finding More:: How to find more information.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4693 * simplified-beginning-of-buffer:: Shows @code{goto-char},
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4694 @code{point-min}, and @code{push-mark}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4695 * mark-whole-buffer:: Almost the same as @code{beginning-of-buffer}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4696 * append-to-buffer:: Uses @code{save-excursion} and
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4697 @code{insert-buffer-substring}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4698 * Buffer Related Review:: Review.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4699 * Buffer Exercises::
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4700 @end menu
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4701
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4702 @node Finding More, simplified-beginning-of-buffer, Buffer Walk Through, Buffer Walk Through
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4703 @section Finding More Information
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4704
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4705 @findex describe-function, @r{introduced}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4706 @cindex Find function documentation
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4707 In this walk-through, I will describe each new function as we come to
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4708 it, sometimes in detail and sometimes briefly. If you are interested,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4709 you can get the full documentation of any Emacs Lisp function at any
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4710 time by typing @kbd{C-h f} and then the name of the function (and then
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4711 @key{RET}). Similarly, you can get the full documentation for a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4712 variable by typing @kbd{C-h v} and then the name of the variable (and
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4713 then @key{RET}).
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4714
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4715 @cindex Find source of function
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4716 @c In version 22, tells location both of C and of Emacs Lisp
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4717 Also, @code{describe-function} will tell you the location of the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4718 function definition.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4719
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4720 Put point into the name of the file that contains the function and
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4721 press the @key{RET} key. In this case, @key{RET} means
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4722 @code{push-button} rather than `return' or `enter'. Emacs will take
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4723 you directly to the function definition.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4724
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4725 @ignore
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4726 Not In version 22
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4727
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4728 If you move point over the file name and press
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4729 the @key{RET} key, which in this case means @code{help-follow} rather
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4730 than `return' or `enter', Emacs will take you directly to the function
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4731 definition.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4732 @end ignore
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4733
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4734 More generally, if you want to see a function in its original source
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4735 file, you can use the @code{find-tags} function to jump to it.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4736 @code{find-tags} works with a wide variety of languages, not just
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4737 Lisp, and C, and it works with non-programming text as well. For
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4738 example, @code{find-tags} will jump to the various nodes in the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4739 Texinfo source file of this document.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4740 The @code{find-tags} function depends on `tags tables' that record
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4741 the locations of the functions, variables, and other items to which
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4742 @code{find-tags} jumps.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4743
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4744 To use the @code{find-tags} command, type @kbd{M-.} (i.e., press the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4745 period key while holding down the @key{META} key, or else type the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4746 @key{ESC} key and then type the period key), and then, at the prompt,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4747 type in the name of the function whose source code you want to see,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4748 such as @code{mark-whole-buffer}, and then type @key{RET}. Emacs will
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4749 switch buffers and display the source code for the function on your
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4750 screen. To switch back to your current buffer, type @kbd{C-x b
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4751 @key{RET}}. (On some keyboards, the @key{META} key is labelled
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4752 @key{ALT}.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4753
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4754 @c !!! 22.1.1 tags table location in this paragraph
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4755 @cindex TAGS table, specifying
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4756 @findex find-tags
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4757 Depending on how the initial default values of your copy of Emacs are
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4758 set, you may also need to specify the location of your `tags table',
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4759 which is a file called @file{TAGS}. For example, if you are
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4760 interested in Emacs sources, the tags table you will most likely want,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4761 if it has already been created for you, will be in a subdirectory of
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4762 the @file{/usr/local/share/emacs/} directory; thus you would use the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4763 @code{M-x visit-tags-table} command and specify a pathname such as
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4764 @file{/usr/local/share/emacs/22.1.1/lisp/TAGS}. If the tags table
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4765 has not already been created, you will have to create it yourself. It
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4766 will in a file such as @file{/usr/local/src/emacs/src/TAGS}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4767
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4768 @need 1250
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4769 To create a @file{TAGS} file in a specific directory, switch to that
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4770 directory in Emacs using @kbd{M-x cd} command, or list the directory
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4771 with @kbd{C-x d} (@code{dired}). Then run the compile command, with
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4772 @w{@code{etags *.el}} as the command to execute:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4773
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4774 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4775 M-x compile RET etags *.el RET
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4776 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4777
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4778 For more information, see @ref{etags, , Create Your Own @file{TAGS} File}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4779
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4780 After you become more familiar with Emacs Lisp, you will find that you will
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4781 frequently use @code{find-tags} to navigate your way around source code;
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4782 and you will create your own @file{TAGS} tables.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4783
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4784 @cindex Library, as term for `file'
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4785 Incidentally, the files that contain Lisp code are conventionally
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4786 called @dfn{libraries}. The metaphor is derived from that of a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4787 specialized library, such as a law library or an engineering library,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4788 rather than a general library. Each library, or file, contains
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4789 functions that relate to a particular topic or activity, such as
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4790 @file{abbrev.el} for handling abbreviations and other typing
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4791 shortcuts, and @file{help.el} for on-line help. (Sometimes several
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4792 libraries provide code for a single activity, as the various
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4793 @file{rmail@dots{}} files provide code for reading electronic mail.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4794 In @cite{The GNU Emacs Manual}, you will see sentences such as ``The
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4795 @kbd{C-h p} command lets you search the standard Emacs Lisp libraries
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4796 by topic keywords.''
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4797
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4798 @node simplified-beginning-of-buffer, mark-whole-buffer, Finding More, Buffer Walk Through
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4799 @comment node-name, next, previous, up
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4800 @section A Simplified @code{beginning-of-buffer} Definition
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4801 @findex simplified-beginning-of-buffer
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4802
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4803 The @code{beginning-of-buffer} command is a good function to start with
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4804 since you are likely to be familiar with it and it is easy to
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4805 understand. Used as an interactive command, @code{beginning-of-buffer}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4806 moves the cursor to the beginning of the buffer, leaving the mark at the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4807 previous position. It is generally bound to @kbd{M-<}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4808
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4809 In this section, we will discuss a shortened version of the function
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4810 that shows how it is most frequently used. This shortened function
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4811 works as written, but it does not contain the code for a complex option.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4812 In another section, we will describe the entire function.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4813 (@xref{beginning-of-buffer, , Complete Definition of
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4814 @code{beginning-of-buffer}}.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4815
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4816 Before looking at the code, let's consider what the function
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4817 definition has to contain: it must include an expression that makes
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4818 the function interactive so it can be called by typing @kbd{M-x
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4819 beginning-of-buffer} or by typing a keychord such as @kbd{M-<}; it
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4820 must include code to leave a mark at the original position in the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4821 buffer; and it must include code to move the cursor to the beginning
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4822 of the buffer.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4823
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4824 @need 1250
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4825 Here is the complete text of the shortened version of the function:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4826
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4827 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4828 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4829 (defun simplified-beginning-of-buffer ()
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4830 "Move point to the beginning of the buffer;
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4831 leave mark at previous position."
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4832 (interactive)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4833 (push-mark)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4834 (goto-char (point-min)))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4835 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4836 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4837
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4838 Like all function definitions, this definition has five parts following
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4839 the special form @code{defun}:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4840
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4841 @enumerate
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4842 @item
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4843 The name: in this example, @code{simplified-beginning-of-buffer}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4844
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4845 @item
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4846 A list of the arguments: in this example, an empty list, @code{()},
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4847
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4848 @item
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4849 The documentation string.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4850
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4851 @item
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4852 The interactive expression.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4853
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4854 @item
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4855 The body.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4856 @end enumerate
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4857
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4858 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4859 In this function definition, the argument list is empty; this means that
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4860 this function does not require any arguments. (When we look at the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4861 definition for the complete function, we will see that it may be passed
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4862 an optional argument.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4863
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4864 The interactive expression tells Emacs that the function is intended to
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4865 be used interactively. In this example, @code{interactive} does not have
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4866 an argument because @code{simplified-beginning-of-buffer} does not
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4867 require one.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4868
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4869 @need 800
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4870 The body of the function consists of the two lines:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4871
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4872 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4873 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4874 (push-mark)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4875 (goto-char (point-min))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4876 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4877 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4878
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4879 The first of these lines is the expression, @code{(push-mark)}. When
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4880 this expression is evaluated by the Lisp interpreter, it sets a mark at
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4881 the current position of the cursor, wherever that may be. The position
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4882 of this mark is saved in the mark ring.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4883
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4884 The next line is @code{(goto-char (point-min))}. This expression
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4885 jumps the cursor to the minimum point in the buffer, that is, to the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4886 beginning of the buffer (or to the beginning of the accessible portion
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4887 of the buffer if it is narrowed. @xref{Narrowing & Widening, ,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4888 Narrowing and Widening}.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4889
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4890 The @code{push-mark} command sets a mark at the place where the cursor
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4891 was located before it was moved to the beginning of the buffer by the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4892 @code{(goto-char (point-min))} expression. Consequently, you can, if
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4893 you wish, go back to where you were originally by typing @kbd{C-x C-x}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4894
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4895 That is all there is to the function definition!
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4896
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4897 @findex describe-function
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4898 When you are reading code such as this and come upon an unfamiliar
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4899 function, such as @code{goto-char}, you can find out what it does by
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4900 using the @code{describe-function} command. To use this command, type
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4901 @kbd{C-h f} and then type in the name of the function and press
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4902 @key{RET}. The @code{describe-function} command will print the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4903 function's documentation string in a @file{*Help*} window. For
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4904 example, the documentation for @code{goto-char} is:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4905
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4906 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4907 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4908 Set point to POSITION, a number or marker.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4909 Beginning of buffer is position (point-min), end is (point-max).
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4910 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4911 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4912
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4913 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4914 The function's one argument is the desired position.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4915
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4916 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4917 (The prompt for @code{describe-function} will offer you the symbol
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4918 under or preceding the cursor, so you can save typing by positioning
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4919 the cursor right over or after the function and then typing @kbd{C-h f
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4920 @key{RET}}.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4921
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4922 The @code{end-of-buffer} function definition is written in the same way as
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4923 the @code{beginning-of-buffer} definition except that the body of the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4924 function contains the expression @code{(goto-char (point-max))} in place
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4925 of @code{(goto-char (point-min))}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4926
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4927 @node mark-whole-buffer, append-to-buffer, simplified-beginning-of-buffer, Buffer Walk Through
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4928 @comment node-name, next, previous, up
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4929 @section The Definition of @code{mark-whole-buffer}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4930 @findex mark-whole-buffer
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4931
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4932 The @code{mark-whole-buffer} function is no harder to understand than the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4933 @code{simplified-beginning-of-buffer} function. In this case, however,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4934 we will look at the complete function, not a shortened version.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4935
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4936 The @code{mark-whole-buffer} function is not as commonly used as the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4937 @code{beginning-of-buffer} function, but is useful nonetheless: it
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4938 marks a whole buffer as a region by putting point at the beginning and
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4939 a mark at the end of the buffer. It is generally bound to @kbd{C-x
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4940 h}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4941
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4942 @menu
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4943 * mark-whole-buffer overview::
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4944 * Body of mark-whole-buffer:: Only three lines of code.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4945 @end menu
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4946
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4947 @node mark-whole-buffer overview, Body of mark-whole-buffer, mark-whole-buffer, mark-whole-buffer
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4948 @ifnottex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4949 @unnumberedsubsec An overview of @code{mark-whole-buffer}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4950 @end ifnottex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4951
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4952 @need 1250
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4953 In GNU Emacs 22, the code for the complete function looks like this:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4954
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4955 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4956 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4957 (defun mark-whole-buffer ()
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4958 "Put point at beginning and mark at end of buffer.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4959 You probably should not use this function in Lisp programs;
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4960 it is usually a mistake for a Lisp function to use any subroutine
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4961 that uses or sets the mark."
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4962 (interactive)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4963 (push-mark (point))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4964 (push-mark (point-max) nil t)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4965 (goto-char (point-min)))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4966 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4967 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4968
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4969 @need 1250
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4970 Like all other functions, the @code{mark-whole-buffer} function fits
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4971 into the template for a function definition. The template looks like
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4972 this:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4973
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4974 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4975 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4976 (defun @var{name-of-function} (@var{argument-list})
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4977 "@var{documentation}@dots{}"
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4978 (@var{interactive-expression}@dots{})
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4979 @var{body}@dots{})
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4980 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4981 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4982
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4983 Here is how the function works: the name of the function is
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4984 @code{mark-whole-buffer}; it is followed by an empty argument list,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4985 @samp{()}, which means that the function does not require arguments.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4986 The documentation comes next.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4987
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4988 The next line is an @code{(interactive)} expression that tells Emacs
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4989 that the function will be used interactively. These details are similar
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4990 to the @code{simplified-beginning-of-buffer} function described in the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4991 previous section.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4992
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4993 @need 1250
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4994 @node Body of mark-whole-buffer, , mark-whole-buffer overview, mark-whole-buffer
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4995 @comment node-name, next, previous, up
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4996 @subsection Body of @code{mark-whole-buffer}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4997
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4998 The body of the @code{mark-whole-buffer} function consists of three
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4999 lines of code:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5000
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5001 @c GNU Emacs 22
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5002 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5003 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5004 (push-mark (point))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5005 (push-mark (point-max) nil t)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5006 (goto-char (point-min))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5007 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5008 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5009
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5010 The first of these lines is the expression, @code{(push-mark (point))}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5011
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5012 This line does exactly the same job as the first line of the body of
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5013 the @code{simplified-beginning-of-buffer} function, which is written
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5014 @code{(push-mark)}. In both cases, the Lisp interpreter sets a mark
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5015 at the current position of the cursor.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5016
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5017 I don't know why the expression in @code{mark-whole-buffer} is written
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5018 @code{(push-mark (point))} and the expression in
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5019 @code{beginning-of-buffer} is written @code{(push-mark)}. Perhaps
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5020 whoever wrote the code did not know that the arguments for
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5021 @code{push-mark} are optional and that if @code{push-mark} is not
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5022 passed an argument, the function automatically sets mark at the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5023 location of point by default. Or perhaps the expression was written
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5024 so as to parallel the structure of the next line. In any case, the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5025 line causes Emacs to determine the position of point and set a mark
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5026 there.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5027
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5028 In earlier versions of GNU Emacs, the next line of
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5029 @code{mark-whole-buffer} was @code{(push-mark (point-max))}. This
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5030 expression sets a mark at the point in the buffer that has the highest
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5031 number. This will be the end of the buffer (or, if the buffer is
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5032 narrowed, the end of the accessible portion of the buffer.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5033 @xref{Narrowing & Widening, , Narrowing and Widening}, for more about
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5034 narrowing.) After this mark has been set, the previous mark, the one
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5035 set at point, is no longer set, but Emacs remembers its position, just
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5036 as all other recent marks are always remembered. This means that you
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5037 can, if you wish, go back to that position by typing @kbd{C-u
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5038 C-@key{SPC}} twice.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5039
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5040 @need 1250
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5041 In GNU Emacs 22, the @code{(point-max)} is slightly more complicated.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5042 The line reads
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5043
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5044 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5045 (push-mark (point-max) nil t)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5046 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5047
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5048 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5049 The expression works nearly the same as before. It sets a mark at the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5050 highest numbered place in the buffer that it can. However, in this
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5051 version, @code{push-mark} has two additional arguments. The second
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5052 argument to @code{push-mark} is @code{nil}. This tells the function
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5053 it @emph{should} display a message that says `Mark set' when it pushes
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5054 the mark. The third argument is @code{t}. This tells
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5055 @code{push-mark} to activate the mark when Transient Mark mode is
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5056 turned on. Transient Mark mode highlights the currently active
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5057 region. It is often turned off.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5058
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5059 Finally, the last line of the function is @code{(goto-char
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5060 (point-min)))}. This is written exactly the same way as it is written
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5061 in @code{beginning-of-buffer}. The expression moves the cursor to
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5062 the minimum point in the buffer, that is, to the beginning of the buffer
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5063 (or to the beginning of the accessible portion of the buffer). As a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5064 result of this, point is placed at the beginning of the buffer and mark
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5065 is set at the end of the buffer. The whole buffer is, therefore, the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5066 region.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5067
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5068 @node append-to-buffer, Buffer Related Review, mark-whole-buffer, Buffer Walk Through
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5069 @comment node-name, next, previous, up
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5070 @section The Definition of @code{append-to-buffer}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5071 @findex append-to-buffer
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5072
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5073 The @code{append-to-buffer} command is more complex than the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5074 @code{mark-whole-buffer} command. What it does is copy the region
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5075 (that is, the part of the buffer between point and mark) from the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5076 current buffer to a specified buffer.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5077
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5078 @menu
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5079 * append-to-buffer overview::
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5080 * append interactive:: A two part interactive expression.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5081 * append-to-buffer body:: Incorporates a @code{let} expression.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5082 * append save-excursion:: How the @code{save-excursion} works.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5083 @end menu
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5084
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5085 @node append-to-buffer overview, append interactive, append-to-buffer, append-to-buffer
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5086 @ifnottex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5087 @unnumberedsubsec An Overview of @code{append-to-buffer}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5088 @end ifnottex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5089
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5090 @findex insert-buffer-substring
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5091 The @code{append-to-buffer} command uses the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5092 @code{insert-buffer-substring} function to copy the region.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5093 @code{insert-buffer-substring} is described by its name: it takes a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5094 string of characters from part of a buffer, a ``substring'', and
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5095 inserts them into another buffer.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5096
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5097 Most of @code{append-to-buffer} is
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5098 concerned with setting up the conditions for
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5099 @code{insert-buffer-substring} to work: the code must specify both the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5100 buffer to which the text will go, the window it comes from and goes
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5101 to, and the region that will be copied.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5102
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5103 @need 1250
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5104 Here is the complete text of the function:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5105
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5106 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5107 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5108 (defun append-to-buffer (buffer start end)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5109 "Append to specified buffer the text of the region.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5110 It is inserted into that buffer before its point.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5111 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5112
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5113 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5114 When calling from a program, give three arguments:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5115 BUFFER (or buffer name), START and END.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5116 START and END specify the portion of the current buffer to be copied."
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5117 (interactive
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5118 (list (read-buffer "Append to buffer: " (other-buffer
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5119 (current-buffer) t))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5120 (region-beginning) (region-end)))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5121 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5122 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5123 (let ((oldbuf (current-buffer)))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5124 (save-excursion
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5125 (let* ((append-to (get-buffer-create buffer))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5126 (windows (get-buffer-window-list append-to t t))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5127 point)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5128 (set-buffer append-to)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5129 (setq point (point))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5130 (barf-if-buffer-read-only)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5131 (insert-buffer-substring oldbuf start end)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5132 (dolist (window windows)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5133 (when (= (window-point window) point)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5134 (set-window-point window (point))))))))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5135 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5136 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5137
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5138 The function can be understood by looking at it as a series of
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5139 filled-in templates.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5140
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5141 The outermost template is for the function definition. In this
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5142 function, it looks like this (with several slots filled in):
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5143
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5144 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5145 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5146 (defun append-to-buffer (buffer start end)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5147 "@var{documentation}@dots{}"
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5148 (interactive @dots{})
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5149 @var{body}@dots{})
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5150 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5151 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5152
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5153 The first line of the function includes its name and three arguments.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5154 The arguments are the @code{buffer} to which the text will be copied, and
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5155 the @code{start} and @code{end} of the region in the current buffer that
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5156 will be copied.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5157
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5158 The next part of the function is the documentation, which is clear and
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5159 complete. As is conventional, the three arguments are written in
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5160 upper case so you will notice them easily. Even better, they are
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5161 described in the same order as in the argument list.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5162
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5163 Note that the documentation distinguishes between a buffer and its
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5164 name. (The function can handle either.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5165
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5166 @node append interactive, append-to-buffer body, append-to-buffer overview, append-to-buffer
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5167 @comment node-name, next, previous, up
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5168 @subsection The @code{append-to-buffer} Interactive Expression
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5169
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5170 Since the @code{append-to-buffer} function will be used interactively,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5171 the function must have an @code{interactive} expression. (For a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5172 review of @code{interactive}, see @ref{Interactive, , Making a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5173 Function Interactive}.) The expression reads as follows:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5174
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5175 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5176 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5177 (interactive
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5178 (list (read-buffer
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5179 "Append to buffer: "
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5180 (other-buffer (current-buffer) t))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5181 (region-beginning)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5182 (region-end)))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5183 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5184 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5185
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5186 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5187 This expression is not one with letters standing for parts, as
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5188 described earlier. Instead, it starts a list with these parts:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5189
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5190 The first part of the list is an expression to read the name of a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5191 buffer and return it as a string. That is @code{read-buffer}. The
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5192 function requires a prompt as its first argument, @samp{"Append to
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5193 buffer: "}. Its second argument tells the command what value to
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5194 provide if you don't specify anything.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5195
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5196 In this case that second argument is an expression containing the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5197 function @code{other-buffer}, an exception, and a @samp{t}, standing
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5198 for true.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5199
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5200 The first argument to @code{other-buffer}, the exception, is yet
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5201 another function, @code{current-buffer}. That is not going to be
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5202 returned. The second argument is the symbol for true, @code{t}. that
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5203 tells @code{other-buffer} that it may show visible buffers (except in
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5204 this case, it will not show the current buffer, which makes sense).
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5205
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5206 @need 1250
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5207 The expression looks like this:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5208
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5209 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5210 (other-buffer (current-buffer) t)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5211 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5212
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5213 The second and third arguments to the @code{list} expression are
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5214 @code{(region-beginning)} and @code{(region-end)}. These two
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5215 functions specify the beginning and end of the text to be appended.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5216
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5217 @need 1250
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5218 Originally, the command used the letters @samp{B} and @samp{r}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5219 The whole @code{interactive} expression looked like this:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5220
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5221 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5222 (interactive "BAppend to buffer:@: \nr")
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5223 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5224
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5225 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5226 But when that was done, the default value of the buffer switched to
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5227 was invisible. That was not wanted.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5228
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5229 (The prompt was separated from the second argument with a newline,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5230 @samp{\n}. It was followed by an @samp{r} that told Emacs to bind the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5231 two arguments that follow the symbol @code{buffer} in the function's
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5232 argument list (that is, @code{start} and @code{end}) to the values of
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5233 point and mark. That argument worked fine.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5234
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5235 @node append-to-buffer body, append save-excursion, append interactive, append-to-buffer
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5236 @comment node-name, next, previous, up
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5237 @subsection The Body of @code{append-to-buffer}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5238
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5239 @ignore
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5240 in GNU Emacs 22 in /usr/local/src/emacs/lisp/simple.el
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5241
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5242 (defun append-to-buffer (buffer start end)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5243 "Append to specified buffer the text of the region.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5244 It is inserted into that buffer before its point.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5245
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5246 When calling from a program, give three arguments:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5247 BUFFER (or buffer name), START and END.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5248 START and END specify the portion of the current buffer to be copied."
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5249 (interactive
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5250 (list (read-buffer "Append to buffer: " (other-buffer (current-buffer) t))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5251 (region-beginning) (region-end)))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5252 (let ((oldbuf (current-buffer)))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5253 (save-excursion
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5254 (let* ((append-to (get-buffer-create buffer))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5255 (windows (get-buffer-window-list append-to t t))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5256 point)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5257 (set-buffer append-to)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5258 (setq point (point))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5259 (barf-if-buffer-read-only)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5260 (insert-buffer-substring oldbuf start end)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5261 (dolist (window windows)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5262 (when (= (window-point window) point)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5263 (set-window-point window (point))))))))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5264 @end ignore
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5265
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5266 The body of the @code{append-to-buffer} function begins with @code{let}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5267
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5268 As we have seen before (@pxref{let, , @code{let}}), the purpose of a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5269 @code{let} expression is to create and give initial values to one or
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5270 more variables that will only be used within the body of the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5271 @code{let}. This means that such a variable will not be confused with
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5272 any variable of the same name outside the @code{let} expression.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5273
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5274 We can see how the @code{let} expression fits into the function as a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5275 whole by showing a template for @code{append-to-buffer} with the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5276 @code{let} expression in outline:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5277
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5278 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5279 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5280 (defun append-to-buffer (buffer start end)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5281 "@var{documentation}@dots{}"
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5282 (interactive @dots{})
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5283 (let ((@var{variable} @var{value}))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5284 @var{body}@dots{})
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5285 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5286 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5287
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5288 The @code{let} expression has three elements:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5289
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5290 @enumerate
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5291 @item
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5292 The symbol @code{let};
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5293
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5294 @item
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5295 A varlist containing, in this case, a single two-element list,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5296 @code{(@var{variable} @var{value})};
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5297
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5298 @item
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5299 The body of the @code{let} expression.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5300 @end enumerate
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5301
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5302 @need 800
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5303 In the @code{append-to-buffer} function, the varlist looks like this:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5304
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5305 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5306 (oldbuf (current-buffer))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5307 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5308
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5309 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5310 In this part of the @code{let} expression, the one variable,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5311 @code{oldbuf}, is bound to the value returned by the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5312 @code{(current-buffer)} expression. The variable, @code{oldbuf}, is
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5313 used to keep track of the buffer in which you are working and from
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5314 which you will copy.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5315
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5316 The element or elements of a varlist are surrounded by a set of
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5317 parentheses so the Lisp interpreter can distinguish the varlist from
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5318 the body of the @code{let}. As a consequence, the two-element list
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5319 within the varlist is surrounded by a circumscribing set of parentheses.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5320 The line looks like this:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5321
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5322 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5323 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5324 (let ((oldbuf (current-buffer)))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5325 @dots{} )
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5326 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5327 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5328
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5329 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5330 The two parentheses before @code{oldbuf} might surprise you if you did
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5331 not realize that the first parenthesis before @code{oldbuf} marks the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5332 boundary of the varlist and the second parenthesis marks the beginning
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5333 of the two-element list, @code{(oldbuf (current-buffer))}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5334
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5335 @node append save-excursion, , append-to-buffer body, append-to-buffer
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5336 @comment node-name, next, previous, up
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5337 @subsection @code{save-excursion} in @code{append-to-buffer}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5338
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5339 The body of the @code{let} expression in @code{append-to-buffer}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5340 consists of a @code{save-excursion} expression.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5341
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5342 The @code{save-excursion} function saves the locations of point and
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5343 mark, and restores them to those positions after the expressions in the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5344 body of the @code{save-excursion} complete execution. In addition,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5345 @code{save-excursion} keeps track of the original buffer, and
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5346 restores it. This is how @code{save-excursion} is used in
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5347 @code{append-to-buffer}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5348
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5349 @need 1500
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5350 @cindex Indentation for formatting
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5351 @cindex Formatting convention
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5352 Incidentally, it is worth noting here that a Lisp function is normally
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5353 formatted so that everything that is enclosed in a multi-line spread is
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5354 indented more to the right than the first symbol. In this function
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5355 definition, the @code{let} is indented more than the @code{defun}, and
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5356 the @code{save-excursion} is indented more than the @code{let}, like
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5357 this:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5358
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5359 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5360 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5361 (defun @dots{}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5362 @dots{}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5363 @dots{}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5364 (let@dots{}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5365 (save-excursion
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5366 @dots{}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5367 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5368 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5369
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5370 @need 1500
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5371 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5372 This formatting convention makes it easy to see that the lines in
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5373 the body of the @code{save-excursion} are enclosed by the parentheses
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5374 associated with @code{save-excursion}, just as the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5375 @code{save-excursion} itself is enclosed by the parentheses associated
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5376 with the @code{let}:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5377
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5378 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5379 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5380 (let ((oldbuf (current-buffer)))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5381 (save-excursion
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5382 @dots{}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5383 (set-buffer @dots{})
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5384 (insert-buffer-substring oldbuf start end)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5385 @dots{}))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5386 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5387 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5388
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5389 @need 1200
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5390 The use of the @code{save-excursion} function can be viewed as a process
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5391 of filling in the slots of a template:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5392
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5393 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5394 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5395 (save-excursion
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5396 @var{first-expression-in-body}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5397 @var{second-expression-in-body}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5398 @dots{}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5399 @var{last-expression-in-body})
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5400 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5401 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5402
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5403 @need 1200
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5404 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5405 In this function, the body of the @code{save-excursion} contains only
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5406 one expression, the @code{let*} expression. You know about a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5407 @code{let} function. The @code{let*} function is different. It has a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5408 @samp{*} in its name. It enables Emacs to set each variable in its
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5409 varlist in sequence, one after another.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5410
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5411 Its critical feature is that variables later in the varlist can make
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5412 use of the values to which Emacs set variables earlier in the varlist.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5413 @xref{fwd-para let, , The @code{let*} expression}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5414
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5415 We will skip functions like @code{let*} and focus on two: the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5416 @code{set-buffer} function and the @code{insert-buffer-substring}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5417 function.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5418
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5419 @need 1250
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5420 In the old days, the @code{set-buffer} expression was simply
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5421
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5422 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5423 (set-buffer (get-buffer-create buffer))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5424 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5425
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5426 @need 1250
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5427 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5428 but now it is
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5429
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5430 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5431 (set-buffer append-to)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5432 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5433
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5434 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5435 @code{append-to} is bound to @code{(get-buffer-create buffer)} earlier
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5436 on in the @code{let*} expression. That extra binding would not be
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5437 necessary except for that @code{append-to} is used later in the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5438 varlist as an argument to @code{get-buffer-window-list}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5439
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5440 @ignore
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5441 in GNU Emacs 22
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5442
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5443 (let ((oldbuf (current-buffer)))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5444 (save-excursion
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5445 (let* ((append-to (get-buffer-create buffer))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5446 (windows (get-buffer-window-list append-to t t))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5447 point)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5448 (set-buffer append-to)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5449 (setq point (point))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5450 (barf-if-buffer-read-only)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5451 (insert-buffer-substring oldbuf start end)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5452 (dolist (window windows)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5453 (when (= (window-point window) point)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5454 (set-window-point window (point))))))))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5455 @end ignore
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5456
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5457 The @code{append-to-buffer} function definition inserts text from the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5458 buffer in which you are currently to a named buffer. It happens that
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5459 @code{insert-buffer-substring} copies text from another buffer to the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5460 current buffer, just the reverse---that is why the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5461 @code{append-to-buffer} definition starts out with a @code{let} that
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5462 binds the local symbol @code{oldbuf} to the value returned by
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5463 @code{current-buffer}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5464
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5465 @need 1250
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5466 The @code{insert-buffer-substring} expression looks like this:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5467
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5468 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5469 (insert-buffer-substring oldbuf start end)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5470 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5471
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5472 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5473 The @code{insert-buffer-substring} function copies a string
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5474 @emph{from} the buffer specified as its first argument and inserts the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5475 string into the present buffer. In this case, the argument to
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5476 @code{insert-buffer-substring} is the value of the variable created
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5477 and bound by the @code{let}, namely the value of @code{oldbuf}, which
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5478 was the current buffer when you gave the @code{append-to-buffer}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5479 command.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5480
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5481 After @code{insert-buffer-substring} has done its work,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5482 @code{save-excursion} will restore the action to the original buffer
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5483 and @code{append-to-buffer} will have done its job.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5484
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5485 @need 800
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5486 Written in skeletal form, the workings of the body look like this:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5487
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5488 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5489 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5490 (let (@var{bind-}@code{oldbuf}@var{-to-value-of-}@code{current-buffer})
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5491 (save-excursion ; @r{Keep track of buffer.}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5492 @var{change-buffer}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5493 @var{insert-substring-from-}@code{oldbuf}@var{-into-buffer})
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5494
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5495 @var{change-back-to-original-buffer-when-finished}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5496 @var{let-the-local-meaning-of-}@code{oldbuf}@var{-disappear-when-finished}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5497 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5498 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5499
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5500 In summary, @code{append-to-buffer} works as follows: it saves the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5501 value of the current buffer in the variable called @code{oldbuf}. It
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5502 gets the new buffer (creating one if need be) and switches Emacs'
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5503 attention to it. Using the value of @code{oldbuf}, it inserts the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5504 region of text from the old buffer into the new buffer; and then using
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5505 @code{save-excursion}, it brings you back to your original buffer.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5506
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5507 In looking at @code{append-to-buffer}, you have explored a fairly
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5508 complex function. It shows how to use @code{let} and
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5509 @code{save-excursion}, and how to change to and come back from another
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5510 buffer. Many function definitions use @code{let},
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5511 @code{save-excursion}, and @code{set-buffer} this way.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5512
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5513 @node Buffer Related Review, Buffer Exercises, append-to-buffer, Buffer Walk Through
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5514 @comment node-name, next, previous, up
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5515 @section Review
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5516
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5517 Here is a brief summary of the various functions discussed in this chapter.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5518
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5519 @table @code
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5520 @item describe-function
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5521 @itemx describe-variable
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5522 Print the documentation for a function or variable.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5523 Conventionally bound to @kbd{C-h f} and @kbd{C-h v}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5524
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5525 @item find-tag
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5526 Find the file containing the source for a function or variable and
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5527 switch buffers to it, positioning point at the beginning of the item.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5528 Conventionally bound to @kbd{M-.} (that's a period following the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5529 @key{META} key).
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5530
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5531 @item save-excursion
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5532 Save the location of point and mark and restore their values after the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5533 arguments to @code{save-excursion} have been evaluated. Also, remember
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5534 the current buffer and return to it.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5535
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5536 @item push-mark
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5537 Set mark at a location and record the value of the previous mark on the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5538 mark ring. The mark is a location in the buffer that will keep its
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5539 relative position even if text is added to or removed from the buffer.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5540
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5541 @item goto-char
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5542 Set point to the location specified by the value of the argument, which
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5543 can be a number, a marker, or an expression that returns the number of
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5544 a position, such as @code{(point-min)}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5545
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5546 @item insert-buffer-substring
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5547 Copy a region of text from a buffer that is passed to the function as
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5548 an argument and insert the region into the current buffer.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5549
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5550 @item mark-whole-buffer
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5551 Mark the whole buffer as a region. Normally bound to @kbd{C-x h}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5552
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5553 @item set-buffer
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5554 Switch the attention of Emacs to another buffer, but do not change the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5555 window being displayed. Used when the program rather than a human is
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5556 to work on a different buffer.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5557
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5558 @item get-buffer-create
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5559 @itemx get-buffer
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5560 Find a named buffer or create one if a buffer of that name does not
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5561 exist. The @code{get-buffer} function returns @code{nil} if the named
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5562 buffer does not exist.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5563 @end table
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5564
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5565 @need 1500
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5566 @node Buffer Exercises, , Buffer Related Review, Buffer Walk Through
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5567 @section Exercises
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5568
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5569 @itemize @bullet
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5570 @item
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5571 Write your own @code{simplified-end-of-buffer} function definition;
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5572 then test it to see whether it works.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5573
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5574 @item
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5575 Use @code{if} and @code{get-buffer} to write a function that prints a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5576 message telling you whether a buffer exists.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5577
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5578 @item
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5579 Using @code{find-tag}, find the source for the @code{copy-to-buffer}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5580 function.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5581 @end itemize
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5582
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5583 @node More Complex, Narrowing & Widening, Buffer Walk Through, Top
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5584 @comment node-name, next, previous, up
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5585 @chapter A Few More Complex Functions
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5586
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5587 In this chapter, we build on what we have learned in previous chapters
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5588 by looking at more complex functions. The @code{copy-to-buffer}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5589 function illustrates use of two @code{save-excursion} expressions in
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5590 one definition, while the @code{insert-buffer} function illustrates
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5591 use of an asterisk in an @code{interactive} expression, use of
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5592 @code{or}, and the important distinction between a name and the object
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5593 to which the name refers.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5594
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5595 @menu
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5596 * copy-to-buffer:: With @code{set-buffer}, @code{get-buffer-create}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5597 * insert-buffer:: Read-only, and with @code{or}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5598 * beginning-of-buffer:: Shows @code{goto-char},
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5599 @code{point-min}, and @code{push-mark}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5600 * Second Buffer Related Review::
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5601 * optional Exercise::
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5602 @end menu
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5603
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5604 @node copy-to-buffer, insert-buffer, More Complex, More Complex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5605 @comment node-name, next, previous, up
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5606 @section The Definition of @code{copy-to-buffer}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5607 @findex copy-to-buffer
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5608
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5609 After understanding how @code{append-to-buffer} works, it is easy to
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5610 understand @code{copy-to-buffer}. This function copies text into a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5611 buffer, but instead of adding to the second buffer, it replaces all the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5612 previous text in the second buffer.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5613
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5614 @need 800
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5615 The body of @code{copy-to-buffer} looks like this,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5616
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5617 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5618 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5619 @dots{}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5620 (interactive "BCopy to buffer: \nr")
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5621 (let ((oldbuf (current-buffer)))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5622 (with-current-buffer (get-buffer-create buffer)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5623 (barf-if-buffer-read-only)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5624 (erase-buffer)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5625 (save-excursion
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5626 (insert-buffer-substring oldbuf start end)))))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5627 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5628 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5629
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5630 The @code{copy-to-buffer} function has a simpler @code{interactive}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5631 expression than @code{append-to-buffer}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5632
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5633 @need 800
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5634 The definition then says
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5635
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5636 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5637 (with-current-buffer (get-buffer-create buffer) @dots{}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5638 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5639
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5640 First, look at the earliest inner expression; that is evaluated first.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5641 That expression starts with @code{get-buffer-create buffer}. The
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5642 function tells the computer to use the buffer with the name specified
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5643 as the one to which you are copying, or if such a buffer does not
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5644 exist, to create it. Then, the @code{with-current-buffer} function
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5645 evaluates its body with that buffer temporarily current.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5646
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5647 (This demonstrates another way to shift the computer's attention but
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5648 not the user's. The @code{append-to-buffer} function showed how to do
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5649 the same with @code{save-excursion} and @code{set-buffer}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5650 @code{with-current-buffer} is a newer, and arguably easier,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5651 mechanism.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5652
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5653 The @code{barf-if-buffer-read-only} function sends you an error
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5654 message saying the buffer is read-only if you cannot modify it.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5655
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5656 The next line has the @code{erase-buffer} function as its sole
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5657 contents. That function erases the buffer.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5658
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5659 Finally, the last two lines contain the @code{save-excursion}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5660 expression with @code{insert-buffer-substring} as its body.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5661 The @code{insert-buffer-substring} expression copies the text from
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5662 the buffer you are in (and you have not seen the computer shift its
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5663 attention, so you don't know that that buffer is now called
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5664 @code{oldbuf}).
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5665
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5666 Incidentally, this is what is meant by `replacement'. To replace text,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5667 Emacs erases the previous text and then inserts new text.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5668
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5669 @need 1250
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5670 In outline, the body of @code{copy-to-buffer} looks like this:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5671
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5672 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5673 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5674 (let (@var{bind-}@code{oldbuf}@var{-to-value-of-}@code{current-buffer})
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5675 (@var{with-the-buffer-you-are-copying-to}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5676 (@var{but-do-not-erase-or-copy-to-a-read-only-buffer})
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5677 (erase-buffer)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5678 (save-excursion
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5679 @var{insert-substring-from-}@code{oldbuf}@var{-into-buffer})))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5680 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5681 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5682
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5683 @node insert-buffer, beginning-of-buffer, copy-to-buffer, More Complex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5684 @comment node-name, next, previous, up
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5685 @section The Definition of @code{insert-buffer}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5686 @findex insert-buffer
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5687
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5688 @code{insert-buffer} is yet another buffer-related function. This
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5689 command copies another buffer @emph{into} the current buffer. It is the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5690 reverse of @code{append-to-buffer} or @code{copy-to-buffer}, since they
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5691 copy a region of text @emph{from} the current buffer to another buffer.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5692
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5693 Here is a discussion based on the original code. The code was
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5694 simplified in 2003 and is harder to understand.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5695
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5696 (@xref{New insert-buffer, , New Body for @code{insert-buffer}}, to see
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5697 a discussion of the new body.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5698
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5699 In addition, this code illustrates the use of @code{interactive} with a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5700 buffer that might be @dfn{read-only} and the important distinction
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5701 between the name of an object and the object actually referred to.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5702
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5703 @menu
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5704 * insert-buffer code::
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5705 * insert-buffer interactive:: When you can read, but not write.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5706 * insert-buffer body:: The body has an @code{or} and a @code{let}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5707 * if & or:: Using an @code{if} instead of an @code{or}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5708 * Insert or:: How the @code{or} expression works.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5709 * Insert let:: Two @code{save-excursion} expressions.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5710 * New insert-buffer::
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5711 @end menu
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5712
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5713 @node insert-buffer code, insert-buffer interactive, insert-buffer, insert-buffer
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5714 @ifnottex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5715 @unnumberedsubsec The Code for @code{insert-buffer}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5716 @end ifnottex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5717
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5718 @need 800
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5719 Here is the earlier code:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5720
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5721 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5722 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5723 (defun insert-buffer (buffer)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5724 "Insert after point the contents of BUFFER.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5725 Puts mark after the inserted text.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5726 BUFFER may be a buffer or a buffer name."
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5727 (interactive "*bInsert buffer:@: ")
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5728 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5729 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5730 (or (bufferp buffer)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5731 (setq buffer (get-buffer buffer)))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5732 (let (start end newmark)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5733 (save-excursion
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5734 (save-excursion
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5735 (set-buffer buffer)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5736 (setq start (point-min) end (point-max)))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5737 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5738 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5739 (insert-buffer-substring buffer start end)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5740 (setq newmark (point)))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5741 (push-mark newmark)))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5742 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5743 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5744
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5745 @need 1200
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5746 As with other function definitions, you can use a template to see an
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5747 outline of the function:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5748
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5749 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5750 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5751 (defun insert-buffer (buffer)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5752 "@var{documentation}@dots{}"
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5753 (interactive "*bInsert buffer:@: ")
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5754 @var{body}@dots{})
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5755 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5756 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5757
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5758 @node insert-buffer interactive, insert-buffer body, insert-buffer code, insert-buffer
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5759 @comment node-name, next, previous, up
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5760 @subsection The Interactive Expression in @code{insert-buffer}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5761 @findex interactive, @r{example use of}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5762
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5763 In @code{insert-buffer}, the argument to the @code{interactive}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5764 declaration has two parts, an asterisk, @samp{*}, and @samp{bInsert
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5765 buffer:@: }.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5766
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5767 @menu
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5768 * Read-only buffer:: When a buffer cannot be modified.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5769 * b for interactive:: An existing buffer or else its name.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5770 @end menu
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5771
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5772 @node Read-only buffer, b for interactive, insert-buffer interactive, insert-buffer interactive
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5773 @comment node-name, next, previous, up
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5774 @unnumberedsubsubsec A Read-only Buffer
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5775 @cindex Read-only buffer
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5776 @cindex Asterisk for read-only buffer
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5777 @findex * @r{for read-only buffer}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5778
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5779 The asterisk is for the situation when the current buffer is a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5780 read-only buffer---a buffer that cannot be modified. If
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5781 @code{insert-buffer} is called when the current buffer is read-only, a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5782 message to this effect is printed in the echo area and the terminal
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5783 may beep or blink at you; you will not be permitted to insert anything
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5784 into current buffer. The asterisk does not need to be followed by a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5785 newline to separate it from the next argument.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5786
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5787 @node b for interactive, , Read-only buffer, insert-buffer interactive
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5788 @comment node-name, next, previous, up
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5789 @unnumberedsubsubsec @samp{b} in an Interactive Expression
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5790
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5791 The next argument in the interactive expression starts with a lower
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5792 case @samp{b}. (This is different from the code for
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5793 @code{append-to-buffer}, which uses an upper-case @samp{B}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5794 @xref{append-to-buffer, , The Definition of @code{append-to-buffer}}.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5795 The lower-case @samp{b} tells the Lisp interpreter that the argument
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5796 for @code{insert-buffer} should be an existing buffer or else its
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5797 name. (The upper-case @samp{B} option provides for the possibility
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5798 that the buffer does not exist.) Emacs will prompt you for the name
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5799 of the buffer, offering you a default buffer, with name completion
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5800 enabled. If the buffer does not exist, you receive a message that
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5801 says ``No match''; your terminal may beep at you as well.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5802
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5803 The new and simplified code generates a list for @code{interactive}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5804 It uses the @code{barf-if-buffer-read-only} and @code{read-buffer}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5805 functions with which we are already familiar and the @code{progn}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5806 special form with which we are not. (It will be described later.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5807
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5808 @node insert-buffer body, if & or, insert-buffer interactive, insert-buffer
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5809 @comment node-name, next, previous, up
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5810 @subsection The Body of the @code{insert-buffer} Function
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5811
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5812 The body of the @code{insert-buffer} function has two major parts: an
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5813 @code{or} expression and a @code{let} expression. The purpose of the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5814 @code{or} expression is to ensure that the argument @code{buffer} is
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5815 bound to a buffer and not just the name of a buffer. The body of the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5816 @code{let} expression contains the code which copies the other buffer
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5817 into the current buffer.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5818
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5819 @need 1250
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5820 In outline, the two expressions fit into the @code{insert-buffer}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5821 function like this:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5822
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5823 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5824 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5825 (defun insert-buffer (buffer)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5826 "@var{documentation}@dots{}"
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5827 (interactive "*bInsert buffer:@: ")
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5828 (or @dots{}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5829 @dots{}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5830 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5831 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5832 (let (@var{varlist})
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5833 @var{body-of-}@code{let}@dots{} )
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5834 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5835 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5836
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5837 To understand how the @code{or} expression ensures that the argument
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5838 @code{buffer} is bound to a buffer and not to the name of a buffer, it
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5839 is first necessary to understand the @code{or} function.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5840
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5841 Before doing this, let me rewrite this part of the function using
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5842 @code{if} so that you can see what is done in a manner that will be familiar.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5843
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5844 @node if & or, Insert or, insert-buffer body, insert-buffer
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5845 @comment node-name, next, previous, up
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5846 @subsection @code{insert-buffer} With an @code{if} Instead of an @code{or}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5847
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5848 The job to be done is to make sure the value of @code{buffer} is a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5849 buffer itself and not the name of a buffer. If the value is the name,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5850 then the buffer itself must be got.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5851
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5852 You can imagine yourself at a conference where an usher is wandering
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5853 around holding a list with your name on it and looking for you: the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5854 usher is ``bound'' to your name, not to you; but when the usher finds
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5855 you and takes your arm, the usher becomes ``bound'' to you.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5856
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5857 @need 800
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5858 In Lisp, you might describe this situation like this:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5859
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5860 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5861 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5862 (if (not (holding-on-to-guest))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5863 (find-and-take-arm-of-guest))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5864 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5865 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5866
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5867 We want to do the same thing with a buffer---if we do not have the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5868 buffer itself, we want to get it.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5869
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5870 @need 1200
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5871 Using a predicate called @code{bufferp} that tells us whether we have a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5872 buffer (rather than its name), we can write the code like this:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5873
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5874 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5875 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5876 (if (not (bufferp buffer)) ; @r{if-part}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5877 (setq buffer (get-buffer buffer))) ; @r{then-part}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5878 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5879 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5880
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5881 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5882 Here, the true-or-false-test of the @code{if} expression is
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5883 @w{@code{(not (bufferp buffer))}}; and the then-part is the expression
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5884 @w{@code{(setq buffer (get-buffer buffer))}}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5885
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5886 In the test, the function @code{bufferp} returns true if its argument is
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5887 a buffer---but false if its argument is the name of the buffer. (The
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5888 last character of the function name @code{bufferp} is the character
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5889 @samp{p}; as we saw earlier, such use of @samp{p} is a convention that
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5890 indicates that the function is a predicate, which is a term that means
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5891 that the function will determine whether some property is true or false.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5892 @xref{Wrong Type of Argument, , Using the Wrong Type Object as an
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5893 Argument}.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5894
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5895 @need 1200
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5896 The function @code{not} precedes the expression @code{(bufferp buffer)},
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5897 so the true-or-false-test looks like this:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5898
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5899 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5900 (not (bufferp buffer))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5901 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5902
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5903 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5904 @code{not} is a function that returns true if its argument is false
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5905 and false if its argument is true. So if @code{(bufferp buffer)}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5906 returns true, the @code{not} expression returns false and vice-verse:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5907 what is ``not true'' is false and what is ``not false'' is true.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5908
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5909 Using this test, the @code{if} expression works as follows: when the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5910 value of the variable @code{buffer} is actually a buffer rather than
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5911 its name, the true-or-false-test returns false and the @code{if}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5912 expression does not evaluate the then-part. This is fine, since we do
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5913 not need to do anything to the variable @code{buffer} if it really is
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5914 a buffer.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5915
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5916 On the other hand, when the value of @code{buffer} is not a buffer
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5917 itself, but the name of a buffer, the true-or-false-test returns true
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5918 and the then-part of the expression is evaluated. In this case, the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5919 then-part is @code{(setq buffer (get-buffer buffer))}. This
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5920 expression uses the @code{get-buffer} function to return an actual
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5921 buffer itself, given its name. The @code{setq} then sets the variable
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5922 @code{buffer} to the value of the buffer itself, replacing its previous
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5923 value (which was the name of the buffer).
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5924
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5925 @node Insert or, Insert let, if & or, insert-buffer
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5926 @comment node-name, next, previous, up
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5927 @subsection The @code{or} in the Body
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5928
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5929 The purpose of the @code{or} expression in the @code{insert-buffer}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5930 function is to ensure that the argument @code{buffer} is bound to a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5931 buffer and not just to the name of a buffer. The previous section shows
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5932 how the job could have been done using an @code{if} expression.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5933 However, the @code{insert-buffer} function actually uses @code{or}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5934 To understand this, it is necessary to understand how @code{or} works.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5935
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5936 @findex or
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5937 An @code{or} function can have any number of arguments. It evaluates
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5938 each argument in turn and returns the value of the first of its
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5939 arguments that is not @code{nil}. Also, and this is a crucial feature
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5940 of @code{or}, it does not evaluate any subsequent arguments after
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5941 returning the first non-@code{nil} value.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5942
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5943 @need 800
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5944 The @code{or} expression looks like this:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5945
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5946 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5947 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5948 (or (bufferp buffer)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5949 (setq buffer (get-buffer buffer)))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5950 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5951 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5952
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5953 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5954 The first argument to @code{or} is the expression @code{(bufferp buffer)}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5955 This expression returns true (a non-@code{nil} value) if the buffer is
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5956 actually a buffer, and not just the name of a buffer. In the @code{or}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5957 expression, if this is the case, the @code{or} expression returns this
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5958 true value and does not evaluate the next expression---and this is fine
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5959 with us, since we do not want to do anything to the value of
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5960 @code{buffer} if it really is a buffer.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5961
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5962 On the other hand, if the value of @code{(bufferp buffer)} is @code{nil},
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5963 which it will be if the value of @code{buffer} is the name of a buffer,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5964 the Lisp interpreter evaluates the next element of the @code{or}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5965 expression. This is the expression @code{(setq buffer (get-buffer
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5966 buffer))}. This expression returns a non-@code{nil} value, which
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5967 is the value to which it sets the variable @code{buffer}---and this
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5968 value is a buffer itself, not the name of a buffer.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5969
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5970 The result of all this is that the symbol @code{buffer} is always
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5971 bound to a buffer itself rather than to the name of a buffer. All
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5972 this is necessary because the @code{set-buffer} function in a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5973 following line only works with a buffer itself, not with the name to a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5974 buffer.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5975
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5976 @need 1250
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5977 Incidentally, using @code{or}, the situation with the usher would be
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5978 written like this:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5979
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5980 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5981 (or (holding-on-to-guest) (find-and-take-arm-of-guest))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5982 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5983
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5984 @node Insert let, New insert-buffer, Insert or, insert-buffer
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5985 @comment node-name, next, previous, up
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5986 @subsection The @code{let} Expression in @code{insert-buffer}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5987
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5988 After ensuring that the variable @code{buffer} refers to a buffer itself
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5989 and not just to the name of a buffer, the @code{insert-buffer function}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5990 continues with a @code{let} expression. This specifies three local
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5991 variables, @code{start}, @code{end}, and @code{newmark} and binds them
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5992 to the initial value @code{nil}. These variables are used inside the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5993 remainder of the @code{let} and temporarily hide any other occurrence of
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5994 variables of the same name in Emacs until the end of the @code{let}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5995
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5996 @need 1200
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5997 The body of the @code{let} contains two @code{save-excursion}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5998 expressions. First, we will look at the inner @code{save-excursion}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5999 expression in detail. The expression looks like this:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6000
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6001 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6002 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6003 (save-excursion
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6004 (set-buffer buffer)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6005 (setq start (point-min) end (point-max)))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6006 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6007 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6008
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6009 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6010 The expression @code{(set-buffer buffer)} changes Emacs' attention
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6011 from the current buffer to the one from which the text will copied.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6012 In that buffer, the variables @code{start} and @code{end} are set to
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6013 the beginning and end of the buffer, using the commands
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6014 @code{point-min} and @code{point-max}. Note that we have here an
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6015 illustration of how @code{setq} is able to set two variables in the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6016 same expression. The first argument of @code{setq} is set to the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6017 value of its second, and its third argument is set to the value of its
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6018 fourth.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6019
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6020 After the body of the inner @code{save-excursion} is evaluated, the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6021 @code{save-excursion} restores the original buffer, but @code{start} and
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6022 @code{end} remain set to the values of the beginning and end of the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6023 buffer from which the text will be copied.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6024
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6025 @need 1250
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6026 The outer @code{save-excursion} expression looks like this:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6027
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6028 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6029 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6030 (save-excursion
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6031 (@var{inner-}@code{save-excursion}@var{-expression}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6032 (@var{go-to-new-buffer-and-set-}@code{start}@var{-and-}@code{end})
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6033 (insert-buffer-substring buffer start end)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6034 (setq newmark (point)))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6035 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6036 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6037
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6038 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6039 The @code{insert-buffer-substring} function copies the text
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6040 @emph{into} the current buffer @emph{from} the region indicated by
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6041 @code{start} and @code{end} in @code{buffer}. Since the whole of the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6042 second buffer lies between @code{start} and @code{end}, the whole of
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6043 the second buffer is copied into the buffer you are editing. Next,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6044 the value of point, which will be at the end of the inserted text, is
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6045 recorded in the variable @code{newmark}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6046
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6047 After the body of the outer @code{save-excursion} is evaluated, point
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6048 and mark are relocated to their original places.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6049
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6050 However, it is convenient to locate a mark at the end of the newly
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6051 inserted text and locate point at its beginning. The @code{newmark}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6052 variable records the end of the inserted text. In the last line of
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6053 the @code{let} expression, the @code{(push-mark newmark)} expression
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6054 function sets a mark to this location. (The previous location of the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6055 mark is still accessible; it is recorded on the mark ring and you can
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6056 go back to it with @kbd{C-u C-@key{SPC}}.) Meanwhile, point is
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6057 located at the beginning of the inserted text, which is where it was
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6058 before you called the insert function, the position of which was saved
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6059 by the first @code{save-excursion}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6060
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6061 @need 1250
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6062 The whole @code{let} expression looks like this:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6063
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6064 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6065 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6066 (let (start end newmark)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6067 (save-excursion
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6068 (save-excursion
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6069 (set-buffer buffer)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6070 (setq start (point-min) end (point-max)))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6071 (insert-buffer-substring buffer start end)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6072 (setq newmark (point)))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6073 (push-mark newmark))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6074 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6075 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6076
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6077 Like the @code{append-to-buffer} function, the @code{insert-buffer}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6078 function uses @code{let}, @code{save-excursion}, and
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6079 @code{set-buffer}. In addition, the function illustrates one way to
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6080 use @code{or}. All these functions are building blocks that we will
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6081 find and use again and again.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6082
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6083 @node New insert-buffer, , Insert let, insert-buffer
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6084 @comment node-name, next, previous, up
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6085 @subsection New Body for @code{insert-buffer}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6086 @findex insert-buffer, new version body
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6087 @findex new version body for insert-buffer
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6088
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6089 The body in the GNU Emacs 22 version is more confusing than the original.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6090
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6091 @need 1250
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6092 It consists of two expressions,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6093
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6094 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6095 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6096 (push-mark
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6097 (save-excursion
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6098 (insert-buffer-substring (get-buffer buffer))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6099 (point)))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6100
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6101 nil
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6102 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6103 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6104
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6105 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6106 except, and this is what confuses novices, very important work is done
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6107 inside the @code{push-mark} expression.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6108
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6109 The @code{get-buffer} function returns a buffer with the name
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6110 provided. You will note that the function is @emph{not} called
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6111 @code{get-buffer-create}; it does not create a buffer if one does not
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6112 already exist. The buffer returned by @code{get-buffer}, an existing
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6113 buffer, is passed to @code{insert-buffer-substring}, which inserts the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6114 whole of the buffer (since you did not specify anything else).
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6115
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6116 The location into which the buffer is inserted is recorded by
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6117 @code{push-mark}. Then the function returns @code{nil}, the value of
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6118 its last command. Put another way, the @code{insert-buffer} function
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6119 exists only to produce a side effect, inserting another buffer, not to
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6120 return any value.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6121
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6122 @node beginning-of-buffer, Second Buffer Related Review, insert-buffer, More Complex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6123 @comment node-name, next, previous, up
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6124 @section Complete Definition of @code{beginning-of-buffer}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6125 @findex beginning-of-buffer
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6126
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6127 The basic structure of the @code{beginning-of-buffer} function has
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6128 already been discussed. (@xref{simplified-beginning-of-buffer, , A
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6129 Simplified @code{beginning-of-buffer} Definition}.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6130 This section describes the complex part of the definition.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6131
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6132 As previously described, when invoked without an argument,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6133 @code{beginning-of-buffer} moves the cursor to the beginning of the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6134 buffer (in truth, the beginning of the accessible portion of the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6135 buffer), leaving the mark at the previous position. However, when the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6136 command is invoked with a number between one and ten, the function
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6137 considers that number to be a fraction of the length of the buffer,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6138 measured in tenths, and Emacs moves the cursor that fraction of the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6139 way from the beginning of the buffer. Thus, you can either call this
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6140 function with the key command @kbd{M-<}, which will move the cursor to
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6141 the beginning of the buffer, or with a key command such as @kbd{C-u 7
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6142 M-<} which will move the cursor to a point 70% of the way through the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6143 buffer. If a number bigger than ten is used for the argument, it
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6144 moves to the end of the buffer.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6145
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6146 The @code{beginning-of-buffer} function can be called with or without an
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6147 argument. The use of the argument is optional.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6148
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6149 @menu
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6150 * Optional Arguments::
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6151 * beginning-of-buffer opt arg:: Example with optional argument.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6152 * beginning-of-buffer complete::
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6153 @end menu
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6154
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6155 @node Optional Arguments, beginning-of-buffer opt arg, beginning-of-buffer, beginning-of-buffer
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6156 @subsection Optional Arguments
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6157
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6158 Unless told otherwise, Lisp expects that a function with an argument in
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6159 its function definition will be called with a value for that argument.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6160 If that does not happen, you get an error and a message that says
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6161 @samp{Wrong number of arguments}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6162
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6163 @cindex Optional arguments
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6164 @cindex Keyword
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6165 @findex optional
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6166 However, optional arguments are a feature of Lisp: a particular
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6167 @dfn{keyword} is used to tell the Lisp interpreter that an argument is
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6168 optional. The keyword is @code{&optional}. (The @samp{&} in front of
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6169 @samp{optional} is part of the keyword.) In a function definition, if
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6170 an argument follows the keyword @code{&optional}, no value need be
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6171 passed to that argument when the function is called.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6172
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6173 @need 1200
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6174 The first line of the function definition of @code{beginning-of-buffer}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6175 therefore looks like this:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6176
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6177 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6178 (defun beginning-of-buffer (&optional arg)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6179 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6180
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6181 @need 1250
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6182 In outline, the whole function looks like this:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6183
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6184 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6185 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6186 (defun beginning-of-buffer (&optional arg)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6187 "@var{documentation}@dots{}"
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6188 (interactive "P")
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6189 (or (@var{is-the-argument-a-cons-cell} arg)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6190 (and @var{are-both-transient-mark-mode-and-mark-active-true})
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6191 (push-mark))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6192 (let (@var{determine-size-and-set-it})
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6193 (goto-char
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6194 (@var{if-there-is-an-argument}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6195 @var{figure-out-where-to-go}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6196 @var{else-go-to}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6197 (point-min))))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6198 @var{do-nicety}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6199 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6200 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6201
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6202 The function is similar to the @code{simplified-beginning-of-buffer}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6203 function except that the @code{interactive} expression has @code{"P"}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6204 as an argument and the @code{goto-char} function is followed by an
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6205 if-then-else expression that figures out where to put the cursor if
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6206 there is an argument that is not a cons cell.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6207
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6208 (Since I do not explain a cons cell for many more chapters, please
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6209 consider ignoring the function @code{consp}. @xref{List
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6210 Implementation, , How Lists are Implemented}, and @ref{Cons Cell Type,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6211 , Cons Cell and List Types, elisp, The GNU Emacs Lisp Reference
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6212 Manual}.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6213
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6214 The @code{"P"} in the @code{interactive} expression tells Emacs to
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6215 pass a prefix argument, if there is one, to the function in raw form.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6216 A prefix argument is made by typing the @key{META} key followed by a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6217 number, or by typing @kbd{C-u} and then a number. (If you don't type
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6218 a number, @kbd{C-u} defaults to a cons cell with a 4. A lowercase
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6219 @code{"p"} in the @code{interactive} expression causes the function to
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6220 convert a prefix arg to a number.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6221
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6222 The true-or-false-test of the @code{if} expression looks complex, but
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6223 it is not: it checks whether @code{arg} has a value that is not
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6224 @code{nil} and whether it is a cons cell. (That is what @code{consp}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6225 does; it checks whether its argument is a cons cell.) If @code{arg}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6226 has a value that is not @code{nil} (and is not a cons cell), which
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6227 will be the case if @code{beginning-of-buffer} is called with a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6228 numeric argument, then this true-or-false-test will return true and
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6229 the then-part of the @code{if} expression will be evaluated. On the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6230 other hand, if @code{beginning-of-buffer} is not called with an
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6231 argument, the value of @code{arg} will be @code{nil} and the else-part
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6232 of the @code{if} expression will be evaluated. The else-part is
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6233 simply @code{point-min}, and when this is the outcome, the whole
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6234 @code{goto-char} expression is @code{(goto-char (point-min))}, which
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6235 is how we saw the @code{beginning-of-buffer} function in its
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6236 simplified form.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6237
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6238 @node beginning-of-buffer opt arg, beginning-of-buffer complete, Optional Arguments, beginning-of-buffer
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6239 @subsection @code{beginning-of-buffer} with an Argument
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6240
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6241 When @code{beginning-of-buffer} is called with an argument, an
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6242 expression is evaluated which calculates what value to pass to
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6243 @code{goto-char}. This expression is rather complicated at first sight.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6244 It includes an inner @code{if} expression and much arithmetic. It looks
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6245 like this:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6246
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6247 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6248 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6249 (if (> (buffer-size) 10000)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6250 ;; @r{Avoid overflow for large buffer sizes!}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6251 (* (prefix-numeric-value arg)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6252 (/ size 10))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6253 (/
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6254 (+ 10
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6255 (*
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6256 size (prefix-numeric-value arg))) 10)))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6257 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6258 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6259
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6260 @menu
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6261 * Disentangle beginning-of-buffer::
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6262 * Large buffer case::
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6263 * Small buffer case::
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6264 @end menu
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6265
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6266 @node Disentangle beginning-of-buffer, Large buffer case, beginning-of-buffer opt arg, beginning-of-buffer opt arg
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6267 @ifnottex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6268 @unnumberedsubsubsec Disentangle @code{beginning-of-buffer}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6269 @end ifnottex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6270
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6271 Like other complex-looking expressions, the conditional expression
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6272 within @code{beginning-of-buffer} can be disentangled by looking at it
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6273 as parts of a template, in this case, the template for an if-then-else
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6274 expression. In skeletal form, the expression looks like this:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6275
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6276 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6277 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6278 (if (@var{buffer-is-large}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6279 @var{divide-buffer-size-by-10-and-multiply-by-arg}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6280 @var{else-use-alternate-calculation}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6281 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6282 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6283
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6284 The true-or-false-test of this inner @code{if} expression checks the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6285 size of the buffer. The reason for this is that the old version 18
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6286 Emacs used numbers that are no bigger than eight million or so and in
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6287 the computation that followed, the programmer feared that Emacs might
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6288 try to use over-large numbers if the buffer were large. The term
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6289 `overflow', mentioned in the comment, means numbers that are over
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6290 large. More recent versions of Emacs use larger numbers, but this
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6291 code has not been touched, if only because people now look at buffers
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6292 that are far, far larger than ever before.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6293
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6294 There are two cases: if the buffer is large and if it is not.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6295
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6296 @node Large buffer case, Small buffer case, Disentangle beginning-of-buffer, beginning-of-buffer opt arg
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6297 @comment node-name, next, previous, up
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6298 @unnumberedsubsubsec What happens in a large buffer
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6299
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6300 In @code{beginning-of-buffer}, the inner @code{if} expression tests
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6301 whether the size of the buffer is greater than 10,000 characters. To do
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6302 this, it uses the @code{>} function and the computation of @code{size}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6303 that comes from the let expression.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6304
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6305 In the old days, the function @code{buffer-size} was used. Not only
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6306 was that function called several times, it gave the size of the whole
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6307 buffer, not the accessible part. The computation makes much more
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6308 sense when it handles just the accessible part. (@xref{Narrowing &
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6309 Widening, , Narrowing and Widening}, for more information on focusing
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6310 attention to an `accessible' part.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6311
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6312 @need 800
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6313 The line looks like this:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6314
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6315 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6316 (if (> size 10000)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6317 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6318
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6319 @need 1200
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6320 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6321 When the buffer is large, the then-part of the @code{if} expression is
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6322 evaluated. It reads like this (after formatting for easy reading):
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6323
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6324 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6325 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6326 (*
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6327 (prefix-numeric-value arg)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6328 (/ size 10))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6329 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6330 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6331
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6332 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6333 This expression is a multiplication, with two arguments to the function
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6334 @code{*}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6335
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6336 The first argument is @code{(prefix-numeric-value arg)}. When
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6337 @code{"P"} is used as the argument for @code{interactive}, the value
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6338 passed to the function as its argument is passed a ``raw prefix
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6339 argument'', and not a number. (It is a number in a list.) To perform
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6340 the arithmetic, a conversion is necessary, and
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6341 @code{prefix-numeric-value} does the job.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6342
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6343 @findex / @r{(division)}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6344 @cindex Division
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6345 The second argument is @code{(/ size 10)}. This expression divides
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6346 the numeric value by ten --- the numeric value of the size of the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6347 accessible portion of the buffer. This produces a number that tells
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6348 how many characters make up one tenth of the buffer size. (In Lisp,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6349 @code{/} is used for division, just as @code{*} is used for
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6350 multiplication.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6351
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6352 @need 1200
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6353 In the multiplication expression as a whole, this amount is multiplied
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6354 by the value of the prefix argument---the multiplication looks like this:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6355
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6356 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6357 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6358 (* @var{numeric-value-of-prefix-arg}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6359 @var{number-of-characters-in-one-tenth-of-the-accessible-buffer})
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6360 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6361 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6362
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6363 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6364 If, for example, the prefix argument is @samp{7}, the one-tenth value
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6365 will be multiplied by 7 to give a position 70% of the way through.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6366
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6367 @need 1200
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6368 The result of all this is that if the accessible portion of the buffer
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6369 is large, the @code{goto-char} expression reads like this:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6370
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6371 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6372 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6373 (goto-char (* (prefix-numeric-value arg)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6374 (/ size 10)))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6375 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6376 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6377
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6378 This puts the cursor where we want it.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6379
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6380 @node Small buffer case, , Large buffer case, beginning-of-buffer opt arg
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6381 @comment node-name, next, previous, up
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6382 @unnumberedsubsubsec What happens in a small buffer
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6383
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6384 If the buffer contains fewer than 10,000 characters, a slightly
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6385 different computation is performed. You might think this is not
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6386 necessary, since the first computation could do the job. However, in
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6387 a small buffer, the first method may not put the cursor on exactly the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6388 desired line; the second method does a better job.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6389
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6390 @need 800
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6391 The code looks like this:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6392
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6393 @c Keep this on one line.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6394 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6395 (/ (+ 10 (* size (prefix-numeric-value arg))) 10))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6396 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6397
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6398 @need 1200
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6399 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6400 This is code in which you figure out what happens by discovering how the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6401 functions are embedded in parentheses. It is easier to read if you
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6402 reformat it with each expression indented more deeply than its
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6403 enclosing expression:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6404
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6405 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6406 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6407 (/
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6408 (+ 10
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6409 (*
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6410 size
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6411 (prefix-numeric-value arg)))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6412 10))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6413 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6414 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6415
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6416 @need 1200
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6417 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6418 Looking at parentheses, we see that the innermost operation is
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6419 @code{(prefix-numeric-value arg)}, which converts the raw argument to
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6420 a number. In the following expression, this number is multiplied by
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6421 the size of the accessible portion of the buffer:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6422
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6423 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6424 (* size (prefix-numeric-value arg))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6425 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6426
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6427 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6428 This multiplication creates a number that may be larger than the size of
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6429 the buffer---seven times larger if the argument is 7, for example. Ten
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6430 is then added to this number and finally the large number is divided by
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6431 ten to provide a value that is one character larger than the percentage
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6432 position in the buffer.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6433
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6434 The number that results from all this is passed to @code{goto-char} and
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6435 the cursor is moved to that point.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6436
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6437 @need 1500
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6438 @node beginning-of-buffer complete, , beginning-of-buffer opt arg, beginning-of-buffer
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6439 @comment node-name, next, previous, up
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6440 @subsection The Complete @code{beginning-of-buffer}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6441
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6442 @need 1000
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6443 Here is the complete text of the @code{beginning-of-buffer} function:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6444 @sp 1
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6445
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6446 @c In GNU Emacs 22
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6447 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6448 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6449 (defun beginning-of-buffer (&optional arg)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6450 "Move point to the beginning of the buffer;
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6451 leave mark at previous position.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6452 With \\[universal-argument] prefix,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6453 do not set mark at previous position.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6454 With numeric arg N,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6455 put point N/10 of the way from the beginning.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6456
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6457 If the buffer is narrowed,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6458 this command uses the beginning and size
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6459 of the accessible part of the buffer.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6460 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6461
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6462 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6463 Don't use this command in Lisp programs!
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6464 \(goto-char (point-min)) is faster
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6465 and avoids clobbering the mark."
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6466 (interactive "P")
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6467 (or (consp arg)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6468 (and transient-mark-mode mark-active)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6469 (push-mark))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6470 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6471 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6472 (let ((size (- (point-max) (point-min))))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6473 (goto-char (if (and arg (not (consp arg)))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6474 (+ (point-min)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6475 (if (> size 10000)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6476 ;; Avoid overflow for large buffer sizes!
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6477 (* (prefix-numeric-value arg)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6478 (/ size 10))
98525
b6395ec3de45 formatting fixes for new printed edition
Karl Berry <karl@gnu.org>
parents: 94896
diff changeset
6479 (/ (+ 10 (* size (prefix-numeric-value arg)))
b6395ec3de45 formatting fixes for new printed edition
Karl Berry <karl@gnu.org>
parents: 94896
diff changeset
6480 10)))
83955
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6481 (point-min))))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6482 (if arg (forward-line 1)))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6483 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6484 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6485
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6486 @ignore
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6487 From before GNU Emacs 22
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6488 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6489 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6490 (defun beginning-of-buffer (&optional arg)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6491 "Move point to the beginning of the buffer;
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6492 leave mark at previous position.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6493 With arg N, put point N/10 of the way
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6494 from the true beginning.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6495 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6496 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6497 Don't use this in Lisp programs!
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6498 \(goto-char (point-min)) is faster
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6499 and does not set the mark."
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6500 (interactive "P")
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6501 (push-mark)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6502 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6503 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6504 (goto-char
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6505 (if arg
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6506 (if (> (buffer-size) 10000)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6507 ;; @r{Avoid overflow for large buffer sizes!}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6508 (* (prefix-numeric-value arg)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6509 (/ (buffer-size) 10))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6510 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6511 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6512 (/ (+ 10 (* (buffer-size)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6513 (prefix-numeric-value arg)))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6514 10))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6515 (point-min)))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6516 (if arg (forward-line 1)))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6517 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6518 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6519 @end ignore
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6520
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6521 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6522 Except for two small points, the previous discussion shows how this
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6523 function works. The first point deals with a detail in the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6524 documentation string, and the second point concerns the last line of
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6525 the function.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6526
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6527 @need 800
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6528 In the documentation string, there is reference to an expression:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6529
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6530 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6531 \\[universal-argument]
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6532 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6533
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6534 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6535 A @samp{\\} is used before the first square bracket of this
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6536 expression. This @samp{\\} tells the Lisp interpreter to substitute
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6537 whatever key is currently bound to the @samp{[@dots{}]}. In the case
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6538 of @code{universal-argument}, that is usually @kbd{C-u}, but it might
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6539 be different. (@xref{Documentation Tips, , Tips for Documentation
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6540 Strings, elisp, The GNU Emacs Lisp Reference Manual}, for more
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6541 information.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6542
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6543 @need 1200
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6544 Finally, the last line of the @code{beginning-of-buffer} command says
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6545 to move point to the beginning of the next line if the command is
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6546 invoked with an argument:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6547
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6548 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6549 (if arg (forward-line 1)))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6550 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6551
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6552 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6553 This puts the cursor at the beginning of the first line after the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6554 appropriate tenths position in the buffer. This is a flourish that
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6555 means that the cursor is always located @emph{at least} the requested
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6556 tenths of the way through the buffer, which is a nicety that is,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6557 perhaps, not necessary, but which, if it did not occur, would be sure
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6558 to draw complaints.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6559
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6560 On the other hand, it also means that if you specify the command with
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6561 a @kbd{C-u}, but without a number, that is to say, if the `raw prefix
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6562 argument' is simply a cons cell, then the command puts you at the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6563 beginning of the second line @dots{} I don't know whether this is
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6564 intended or whether no one has dealt with the code to avoid this
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6565 happening.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6566
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6567 @node Second Buffer Related Review, optional Exercise, beginning-of-buffer, More Complex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6568 @comment node-name, next, previous, up
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6569 @section Review
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6570
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6571 Here is a brief summary of some of the topics covered in this chapter.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6572
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6573 @table @code
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6574 @item or
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6575 Evaluate each argument in sequence, and return the value of the first
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6576 argument that is not @code{nil}; if none return a value that is not
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6577 @code{nil}, return @code{nil}. In brief, return the first true value
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6578 of the arguments; return a true value if one @emph{or} any of the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6579 others are true.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6580
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6581 @item and
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6582 Evaluate each argument in sequence, and if any are @code{nil}, return
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6583 @code{nil}; if none are @code{nil}, return the value of the last
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6584 argument. In brief, return a true value only if all the arguments are
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6585 true; return a true value if one @emph{and} each of the others is
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6586 true.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6587
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6588 @item &optional
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6589 A keyword used to indicate that an argument to a function definition
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6590 is optional; this means that the function can be evaluated without the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6591 argument, if desired.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6592
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6593 @item prefix-numeric-value
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6594 Convert the `raw prefix argument' produced by @code{(interactive
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6595 "P")} to a numeric value.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6596
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6597 @item forward-line
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6598 Move point forward to the beginning of the next line, or if the argument
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6599 is greater than one, forward that many lines. If it can't move as far
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6600 forward as it is supposed to, @code{forward-line} goes forward as far as
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6601 it can and then returns a count of the number of additional lines it was
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6602 supposed to move but couldn't.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6603
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6604 @item erase-buffer
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6605 Delete the entire contents of the current buffer.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6606
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6607 @item bufferp
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6608 Return @code{t} if its argument is a buffer; otherwise return @code{nil}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6609 @end table
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6610
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6611 @node optional Exercise, , Second Buffer Related Review, More Complex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6612 @section @code{optional} Argument Exercise
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6613
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6614 Write an interactive function with an optional argument that tests
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6615 whether its argument, a number, is greater than or equal to, or else,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6616 less than the value of @code{fill-column}, and tells you which, in a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6617 message. However, if you do not pass an argument to the function, use
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6618 56 as a default value.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6619
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6620 @node Narrowing & Widening, car cdr & cons, More Complex, Top
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6621 @comment node-name, next, previous, up
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6622 @chapter Narrowing and Widening
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6623 @cindex Focusing attention (narrowing)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6624 @cindex Narrowing
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6625 @cindex Widening
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6626
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6627 Narrowing is a feature of Emacs that makes it possible for you to focus
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6628 on a specific part of a buffer, and work without accidentally changing
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6629 other parts. Narrowing is normally disabled since it can confuse
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6630 novices.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6631
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6632 @menu
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6633 * Narrowing advantages:: The advantages of narrowing
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6634 * save-restriction:: The @code{save-restriction} special form.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6635 * what-line:: The number of the line that point is on.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6636 * narrow Exercise::
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6637 @end menu
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6638
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6639 @node Narrowing advantages, save-restriction, Narrowing & Widening, Narrowing & Widening
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6640 @ifnottex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6641 @unnumberedsec The Advantages of Narrowing
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6642 @end ifnottex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6643
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6644 With narrowing, the rest of a buffer is made invisible, as if it weren't
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6645 there. This is an advantage if, for example, you want to replace a word
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6646 in one part of a buffer but not in another: you narrow to the part you want
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6647 and the replacement is carried out only in that section, not in the rest
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6648 of the buffer. Searches will only work within a narrowed region, not
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6649 outside of one, so if you are fixing a part of a document, you can keep
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6650 yourself from accidentally finding parts you do not need to fix by
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6651 narrowing just to the region you want.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6652 (The key binding for @code{narrow-to-region} is @kbd{C-x n n}.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6653
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6654 However, narrowing does make the rest of the buffer invisible, which
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6655 can scare people who inadvertently invoke narrowing and think they
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6656 have deleted a part of their file. Moreover, the @code{undo} command
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6657 (which is usually bound to @kbd{C-x u}) does not turn off narrowing
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6658 (nor should it), so people can become quite desperate if they do not
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6659 know that they can return the rest of a buffer to visibility with the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6660 @code{widen} command.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6661 (The key binding for @code{widen} is @kbd{C-x n w}.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6662
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6663 Narrowing is just as useful to the Lisp interpreter as to a human.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6664 Often, an Emacs Lisp function is designed to work on just part of a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6665 buffer; or conversely, an Emacs Lisp function needs to work on all of a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6666 buffer that has been narrowed. The @code{what-line} function, for
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6667 example, removes the narrowing from a buffer, if it has any narrowing
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6668 and when it has finished its job, restores the narrowing to what it was.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6669 On the other hand, the @code{count-lines} function, which is called by
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6670 @code{what-line}, uses narrowing to restrict itself to just that portion
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6671 of the buffer in which it is interested and then restores the previous
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6672 situation.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6673
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6674 @node save-restriction, what-line, Narrowing advantages, Narrowing & Widening
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6675 @comment node-name, next, previous, up
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6676 @section The @code{save-restriction} Special Form
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6677 @findex save-restriction
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6678
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6679 In Emacs Lisp, you can use the @code{save-restriction} special form to
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6680 keep track of whatever narrowing is in effect, if any. When the Lisp
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6681 interpreter meets with @code{save-restriction}, it executes the code
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6682 in the body of the @code{save-restriction} expression, and then undoes
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6683 any changes to narrowing that the code caused. If, for example, the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6684 buffer is narrowed and the code that follows @code{save-restriction}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6685 gets rid of the narrowing, @code{save-restriction} returns the buffer
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6686 to its narrowed region afterwards. In the @code{what-line} command,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6687 any narrowing the buffer may have is undone by the @code{widen}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6688 command that immediately follows the @code{save-restriction} command.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6689 Any original narrowing is restored just before the completion of the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6690 function.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6691
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6692 @need 1250
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6693 The template for a @code{save-restriction} expression is simple:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6694
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6695 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6696 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6697 (save-restriction
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6698 @var{body}@dots{} )
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6699 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6700 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6701
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6702 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6703 The body of the @code{save-restriction} is one or more expressions that
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6704 will be evaluated in sequence by the Lisp interpreter.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6705
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6706 Finally, a point to note: when you use both @code{save-excursion} and
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6707 @code{save-restriction}, one right after the other, you should use
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6708 @code{save-excursion} outermost. If you write them in reverse order,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6709 you may fail to record narrowing in the buffer to which Emacs switches
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6710 after calling @code{save-excursion}. Thus, when written together,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6711 @code{save-excursion} and @code{save-restriction} should be written
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6712 like this:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6713
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6714 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6715 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6716 (save-excursion
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6717 (save-restriction
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6718 @var{body}@dots{}))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6719 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6720 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6721
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6722 In other circumstances, when not written together, the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6723 @code{save-excursion} and @code{save-restriction} special forms must
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6724 be written in the order appropriate to the function.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6725
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6726 @need 1250
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6727 For example,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6728
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6729 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6730 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6731 (save-restriction
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6732 (widen)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6733 (save-excursion
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6734 @var{body}@dots{}))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6735 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6736 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6737
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6738 @ignore
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6739 Emacs 22
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6740 /usr/local/src/emacs/lisp/simple.el
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6741
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6742 (defun what-line ()
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6743 "Print the current buffer line number and narrowed line number of point."
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6744 (interactive)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6745 (let ((start (point-min))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6746 (n (line-number-at-pos)))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6747 (if (= start 1)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6748 (message "Line %d" n)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6749 (save-excursion
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6750 (save-restriction
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6751 (widen)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6752 (message "line %d (narrowed line %d)"
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6753 (+ n (line-number-at-pos start) -1) n))))))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6754
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6755 (defun line-number-at-pos (&optional pos)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6756 "Return (narrowed) buffer line number at position POS.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6757 If POS is nil, use current buffer location.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6758 Counting starts at (point-min), so the value refers
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6759 to the contents of the accessible portion of the buffer."
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6760 (let ((opoint (or pos (point))) start)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6761 (save-excursion
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6762 (goto-char (point-min))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6763 (setq start (point))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6764 (goto-char opoint)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6765 (forward-line 0)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6766 (1+ (count-lines start (point))))))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6767
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6768 (defun count-lines (start end)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6769 "Return number of lines between START and END.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6770 This is usually the number of newlines between them,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6771 but can be one more if START is not equal to END
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6772 and the greater of them is not at the start of a line."
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6773 (save-excursion
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6774 (save-restriction
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6775 (narrow-to-region start end)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6776 (goto-char (point-min))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6777 (if (eq selective-display t)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6778 (save-match-data
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6779 (let ((done 0))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6780 (while (re-search-forward "[\n\C-m]" nil t 40)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6781 (setq done (+ 40 done)))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6782 (while (re-search-forward "[\n\C-m]" nil t 1)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6783 (setq done (+ 1 done)))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6784 (goto-char (point-max))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6785 (if (and (/= start end)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6786 (not (bolp)))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6787 (1+ done)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6788 done)))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6789 (- (buffer-size) (forward-line (buffer-size)))))))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6790 @end ignore
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6791
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6792 @node what-line, narrow Exercise, save-restriction, Narrowing & Widening
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6793 @comment node-name, next, previous, up
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6794 @section @code{what-line}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6795 @findex what-line
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6796 @cindex Widening, example of
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6797
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6798 The @code{what-line} command tells you the number of the line in which
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6799 the cursor is located. The function illustrates the use of the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6800 @code{save-restriction} and @code{save-excursion} commands. Here is the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6801 original text of the function:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6802
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6803 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6804 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6805 (defun what-line ()
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6806 "Print the current line number (in the buffer) of point."
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6807 (interactive)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6808 (save-restriction
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6809 (widen)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6810 (save-excursion
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6811 (beginning-of-line)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6812 (message "Line %d"
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6813 (1+ (count-lines 1 (point)))))))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6814 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6815 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6816
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6817 (In recent versions of GNU Emacs, the @code{what-line} function has
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6818 been expanded to tell you your line number in a narrowed buffer as
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6819 well as your line number in a widened buffer. The recent version is
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6820 more complex than the version shown here. If you feel adventurous,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6821 you might want to look at it after figuring out how this version
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6822 works. You will probably need to use @kbd{C-h f}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6823 (@code{describe-function}). The newer version uses a conditional to
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6824 determine whether the buffer has been narrowed.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6825
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6826 (Also, it uses @code{line-number-at-pos}, which among other simple
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6827 expressions, such as @code{(goto-char (point-min))}, moves point to
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6828 the beginning of the current line with @code{(forward-line 0)} rather
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6829 than @code{beginning-of-line}.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6830
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6831 The @code{what-line} function as shown here has a documentation line
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6832 and is interactive, as you would expect. The next two lines use the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6833 functions @code{save-restriction} and @code{widen}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6834
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6835 The @code{save-restriction} special form notes whatever narrowing is in
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6836 effect, if any, in the current buffer and restores that narrowing after
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6837 the code in the body of the @code{save-restriction} has been evaluated.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6838
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6839 The @code{save-restriction} special form is followed by @code{widen}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6840 This function undoes any narrowing the current buffer may have had
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6841 when @code{what-line} was called. (The narrowing that was there is
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6842 the narrowing that @code{save-restriction} remembers.) This widening
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6843 makes it possible for the line counting commands to count from the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6844 beginning of the buffer. Otherwise, they would have been limited to
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6845 counting within the accessible region. Any original narrowing is
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6846 restored just before the completion of the function by the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6847 @code{save-restriction} special form.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6848
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6849 The call to @code{widen} is followed by @code{save-excursion}, which
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6850 saves the location of the cursor (i.e., of point) and of the mark, and
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6851 restores them after the code in the body of the @code{save-excursion}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6852 uses the @code{beginning-of-line} function to move point.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6853
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6854 (Note that the @code{(widen)} expression comes between the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6855 @code{save-restriction} and @code{save-excursion} special forms. When
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6856 you write the two @code{save- @dots{}} expressions in sequence, write
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6857 @code{save-excursion} outermost.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6858
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6859 @need 1200
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6860 The last two lines of the @code{what-line} function are functions to
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6861 count the number of lines in the buffer and then print the number in the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6862 echo area.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6863
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6864 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6865 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6866 (message "Line %d"
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6867 (1+ (count-lines 1 (point)))))))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6868 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6869 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6870
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6871 The @code{message} function prints a one-line message at the bottom of
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6872 the Emacs screen. The first argument is inside of quotation marks and
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6873 is printed as a string of characters. However, it may contain a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6874 @samp{%d} expression to print a following argument. @samp{%d} prints
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6875 the argument as a decimal, so the message will say something such as
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6876 @samp{Line 243}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6877
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6878 @need 1200
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6879 The number that is printed in place of the @samp{%d} is computed by the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6880 last line of the function:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6881
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6882 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6883 (1+ (count-lines 1 (point)))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6884 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6885
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6886 @ignore
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6887 GNU Emacs 22
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6888
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6889 (defun count-lines (start end)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6890 "Return number of lines between START and END.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6891 This is usually the number of newlines between them,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6892 but can be one more if START is not equal to END
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6893 and the greater of them is not at the start of a line."
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6894 (save-excursion
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6895 (save-restriction
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6896 (narrow-to-region start end)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6897 (goto-char (point-min))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6898 (if (eq selective-display t)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6899 (save-match-data
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6900 (let ((done 0))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6901 (while (re-search-forward "[\n\C-m]" nil t 40)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6902 (setq done (+ 40 done)))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6903 (while (re-search-forward "[\n\C-m]" nil t 1)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6904 (setq done (+ 1 done)))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6905 (goto-char (point-max))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6906 (if (and (/= start end)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6907 (not (bolp)))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6908 (1+ done)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6909 done)))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6910 (- (buffer-size) (forward-line (buffer-size)))))))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6911 @end ignore
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6912
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6913 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6914 What this does is count the lines from the first position of the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6915 buffer, indicated by the @code{1}, up to @code{(point)}, and then add
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6916 one to that number. (The @code{1+} function adds one to its
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6917 argument.) We add one to it because line 2 has only one line before
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6918 it, and @code{count-lines} counts only the lines @emph{before} the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6919 current line.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6920
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6921 After @code{count-lines} has done its job, and the message has been
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6922 printed in the echo area, the @code{save-excursion} restores point and
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6923 mark to their original positions; and @code{save-restriction} restores
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6924 the original narrowing, if any.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6925
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6926 @node narrow Exercise, , what-line, Narrowing & Widening
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6927 @section Exercise with Narrowing
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6928
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6929 Write a function that will display the first 60 characters of the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6930 current buffer, even if you have narrowed the buffer to its latter
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6931 half so that the first line is inaccessible. Restore point, mark, and
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6932 narrowing. For this exercise, you need to use a whole potpourri of
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6933 functions, including @code{save-restriction}, @code{widen},
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6934 @code{goto-char}, @code{point-min}, @code{message}, and
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6935 @code{buffer-substring}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6936
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6937 @cindex Properties, mention of @code{buffer-substring-no-properties}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6938 (@code{buffer-substring} is a previously unmentioned function you will
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6939 have to investigate yourself; or perhaps you will have to use
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6940 @code{buffer-substring-no-properties} or
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6941 @code{filter-buffer-substring} @dots{}, yet other functions. Text
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6942 properties are a feature otherwise not discussed here. @xref{Text
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6943 Properties, , Text Properties, elisp, The GNU Emacs Lisp Reference
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6944 Manual}.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6945
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6946 Additionally, do you really need @code{goto-char} or @code{point-min}?
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6947 Or can you write the function without them?
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6948
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6949 @node car cdr & cons, Cutting & Storing Text, Narrowing & Widening, Top
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6950 @comment node-name, next, previous, up
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6951 @chapter @code{car}, @code{cdr}, @code{cons}: Fundamental Functions
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6952 @findex car, @r{introduced}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6953 @findex cdr, @r{introduced}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6954
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6955 In Lisp, @code{car}, @code{cdr}, and @code{cons} are fundamental
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6956 functions. The @code{cons} function is used to construct lists, and
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6957 the @code{car} and @code{cdr} functions are used to take them apart.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6958
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6959 In the walk through of the @code{copy-region-as-kill} function, we
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6960 will see @code{cons} as well as two variants on @code{cdr},
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6961 namely, @code{setcdr} and @code{nthcdr}. (@xref{copy-region-as-kill}.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6962
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6963 @menu
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6964 * Strange Names:: An historical aside: why the strange names?
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6965 * car & cdr:: Functions for extracting part of a list.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6966 * cons:: Constructing a list.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6967 * nthcdr:: Calling @code{cdr} repeatedly.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6968 * nth::
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6969 * setcar:: Changing the first element of a list.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6970 * setcdr:: Changing the rest of a list.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6971 * cons Exercise::
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6972 @end menu
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6973
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6974 @node Strange Names, car & cdr, car cdr & cons, car cdr & cons
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6975 @ifnottex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6976 @unnumberedsec Strange Names
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6977 @end ifnottex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6978
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6979 The name of the @code{cons} function is not unreasonable: it is an
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6980 abbreviation of the word `construct'. The origins of the names for
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6981 @code{car} and @code{cdr}, on the other hand, are esoteric: @code{car}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6982 is an acronym from the phrase `Contents of the Address part of the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6983 Register'; and @code{cdr} (pronounced `could-er') is an acronym from
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6984 the phrase `Contents of the Decrement part of the Register'. These
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6985 phrases refer to specific pieces of hardware on the very early
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6986 computer on which the original Lisp was developed. Besides being
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6987 obsolete, the phrases have been completely irrelevant for more than 25
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6988 years to anyone thinking about Lisp. Nonetheless, although a few
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6989 brave scholars have begun to use more reasonable names for these
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6990 functions, the old terms are still in use. In particular, since the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6991 terms are used in the Emacs Lisp source code, we will use them in this
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6992 introduction.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6993
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6994 @node car & cdr, cons, Strange Names, car cdr & cons
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6995 @comment node-name, next, previous, up
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6996 @section @code{car} and @code{cdr}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6997
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6998 The @sc{car} of a list is, quite simply, the first item in the list.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6999 Thus the @sc{car} of the list @code{(rose violet daisy buttercup)} is
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7000 @code{rose}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7001
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7002 @need 1200
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7003 If you are reading this in Info in GNU Emacs, you can see this by
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7004 evaluating the following:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7005
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7006 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7007 (car '(rose violet daisy buttercup))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7008 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7009
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7010 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7011 After evaluating the expression, @code{rose} will appear in the echo
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7012 area.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7013
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7014 Clearly, a more reasonable name for the @code{car} function would be
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7015 @code{first} and this is often suggested.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7016
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7017 @code{car} does not remove the first item from the list; it only reports
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7018 what it is. After @code{car} has been applied to a list, the list is
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7019 still the same as it was. In the jargon, @code{car} is
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7020 `non-destructive'. This feature turns out to be important.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7021
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7022 The @sc{cdr} of a list is the rest of the list, that is, the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7023 @code{cdr} function returns the part of the list that follows the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7024 first item. Thus, while the @sc{car} of the list @code{'(rose violet
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7025 daisy buttercup)} is @code{rose}, the rest of the list, the value
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7026 returned by the @code{cdr} function, is @code{(violet daisy
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7027 buttercup)}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7028
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7029 @need 800
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7030 You can see this by evaluating the following in the usual way:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7031
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7032 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7033 (cdr '(rose violet daisy buttercup))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7034 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7035
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7036 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7037 When you evaluate this, @code{(violet daisy buttercup)} will appear in
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7038 the echo area.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7039
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7040 Like @code{car}, @code{cdr} does not remove any elements from the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7041 list---it just returns a report of what the second and subsequent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7042 elements are.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7043
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7044 Incidentally, in the example, the list of flowers is quoted. If it were
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7045 not, the Lisp interpreter would try to evaluate the list by calling
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7046 @code{rose} as a function. In this example, we do not want to do that.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7047
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7048 Clearly, a more reasonable name for @code{cdr} would be @code{rest}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7049
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7050 (There is a lesson here: when you name new functions, consider very
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7051 carefully what you are doing, since you may be stuck with the names
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7052 for far longer than you expect. The reason this document perpetuates
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7053 these names is that the Emacs Lisp source code uses them, and if I did
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7054 not use them, you would have a hard time reading the code; but do,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7055 please, try to avoid using these terms yourself. The people who come
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7056 after you will be grateful to you.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7057
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7058 When @code{car} and @code{cdr} are applied to a list made up of symbols,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7059 such as the list @code{(pine fir oak maple)}, the element of the list
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7060 returned by the function @code{car} is the symbol @code{pine} without
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7061 any parentheses around it. @code{pine} is the first element in the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7062 list. However, the @sc{cdr} of the list is a list itself, @code{(fir
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7063 oak maple)}, as you can see by evaluating the following expressions in
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7064 the usual way:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7065
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7066 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7067 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7068 (car '(pine fir oak maple))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7069
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7070 (cdr '(pine fir oak maple))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7071 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7072 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7073
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7074 On the other hand, in a list of lists, the first element is itself a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7075 list. @code{car} returns this first element as a list. For example,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7076 the following list contains three sub-lists, a list of carnivores, a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7077 list of herbivores and a list of sea mammals:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7078
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7079 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7080 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7081 (car '((lion tiger cheetah)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7082 (gazelle antelope zebra)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7083 (whale dolphin seal)))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7084 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7085 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7086
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7087 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7088 In this example, the first element or @sc{car} of the list is the list of
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7089 carnivores, @code{(lion tiger cheetah)}, and the rest of the list is
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7090 @code{((gazelle antelope zebra) (whale dolphin seal))}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7091
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7092 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7093 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7094 (cdr '((lion tiger cheetah)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7095 (gazelle antelope zebra)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7096 (whale dolphin seal)))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7097 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7098 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7099
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7100 It is worth saying again that @code{car} and @code{cdr} are
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7101 non-destructive---that is, they do not modify or change lists to which
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7102 they are applied. This is very important for how they are used.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7103
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7104 Also, in the first chapter, in the discussion about atoms, I said that
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7105 in Lisp, ``certain kinds of atom, such as an array, can be separated
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7106 into parts; but the mechanism for doing this is different from the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7107 mechanism for splitting a list. As far as Lisp is concerned, the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7108 atoms of a list are unsplittable.'' (@xref{Lisp Atoms}.) The
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7109 @code{car} and @code{cdr} functions are used for splitting lists and
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7110 are considered fundamental to Lisp. Since they cannot split or gain
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7111 access to the parts of an array, an array is considered an atom.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7112 Conversely, the other fundamental function, @code{cons}, can put
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7113 together or construct a list, but not an array. (Arrays are handled
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7114 by array-specific functions. @xref{Arrays, , Arrays, elisp, The GNU
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7115 Emacs Lisp Reference Manual}.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7116
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7117 @node cons, nthcdr, car & cdr, car cdr & cons
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7118 @comment node-name, next, previous, up
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7119 @section @code{cons}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7120 @findex cons, @r{introduced}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7121
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7122 The @code{cons} function constructs lists; it is the inverse of
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7123 @code{car} and @code{cdr}. For example, @code{cons} can be used to make
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7124 a four element list from the three element list, @code{(fir oak maple)}:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7125
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7126 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7127 (cons 'pine '(fir oak maple))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7128 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7129
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7130 @need 800
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7131 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7132 After evaluating this list, you will see
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7133
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7134 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7135 (pine fir oak maple)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7136 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7137
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7138 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7139 appear in the echo area. @code{cons} causes the creation of a new
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7140 list in which the element is followed by the elements of the original
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7141 list.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7142
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7143 We often say that `@code{cons} puts a new element at the beginning of
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7144 a list; it attaches or pushes elements onto the list', but this
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7145 phrasing can be misleading, since @code{cons} does not change an
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7146 existing list, but creates a new one.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7147
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7148 Like @code{car} and @code{cdr}, @code{cons} is non-destructive.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7149
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7150 @menu
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7151 * Build a list::
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7152 * length:: How to find the length of a list.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7153 @end menu
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7154
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7155 @node Build a list, length, cons, cons
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7156 @ifnottex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7157 @unnumberedsubsec Build a list
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7158 @end ifnottex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7159
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7160 @code{cons} must have a list to attach to.@footnote{Actually, you can
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7161 @code{cons} an element to an atom to produce a dotted pair. Dotted
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7162 pairs are not discussed here; see @ref{Dotted Pair Notation, , Dotted
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7163 Pair Notation, elisp, The GNU Emacs Lisp Reference Manual}.} You
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7164 cannot start from absolutely nothing. If you are building a list, you
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7165 need to provide at least an empty list at the beginning. Here is a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7166 series of @code{cons} expressions that build up a list of flowers. If
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7167 you are reading this in Info in GNU Emacs, you can evaluate each of
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7168 the expressions in the usual way; the value is printed in this text
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7169 after @samp{@result{}}, which you may read as `evaluates to'.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7170
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7171 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7172 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7173 (cons 'buttercup ())
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7174 @result{} (buttercup)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7175 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7176
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7177 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7178 (cons 'daisy '(buttercup))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7179 @result{} (daisy buttercup)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7180 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7181
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7182 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7183 (cons 'violet '(daisy buttercup))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7184 @result{} (violet daisy buttercup)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7185 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7186
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7187 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7188 (cons 'rose '(violet daisy buttercup))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7189 @result{} (rose violet daisy buttercup)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7190 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7191 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7192
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7193 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7194 In the first example, the empty list is shown as @code{()} and a list
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7195 made up of @code{buttercup} followed by the empty list is constructed.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7196 As you can see, the empty list is not shown in the list that was
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7197 constructed. All that you see is @code{(buttercup)}. The empty list is
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7198 not counted as an element of a list because there is nothing in an empty
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7199 list. Generally speaking, an empty list is invisible.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7200
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7201 The second example, @code{(cons 'daisy '(buttercup))} constructs a new,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7202 two element list by putting @code{daisy} in front of @code{buttercup};
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7203 and the third example constructs a three element list by putting
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7204 @code{violet} in front of @code{daisy} and @code{buttercup}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7205
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7206 @node length, , Build a list, cons
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7207 @comment node-name, next, previous, up
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7208 @subsection Find the Length of a List: @code{length}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7209 @findex length
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7210
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7211 You can find out how many elements there are in a list by using the Lisp
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7212 function @code{length}, as in the following examples:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7213
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7214 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7215 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7216 (length '(buttercup))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7217 @result{} 1
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7218 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7219
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7220 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7221 (length '(daisy buttercup))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7222 @result{} 2
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7223 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7224
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7225 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7226 (length (cons 'violet '(daisy buttercup)))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7227 @result{} 3
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7228 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7229 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7230
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7231 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7232 In the third example, the @code{cons} function is used to construct a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7233 three element list which is then passed to the @code{length} function as
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7234 its argument.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7235
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7236 @need 1200
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7237 We can also use @code{length} to count the number of elements in an
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7238 empty list:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7239
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7240 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7241 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7242 (length ())
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7243 @result{} 0
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7244 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7245 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7246
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7247 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7248 As you would expect, the number of elements in an empty list is zero.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7249
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7250 An interesting experiment is to find out what happens if you try to find
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7251 the length of no list at all; that is, if you try to call @code{length}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7252 without giving it an argument, not even an empty list:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7253
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7254 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7255 (length )
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7256 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7257
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7258 @need 800
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7259 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7260 What you see, if you evaluate this, is the error message
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7261
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7262 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7263 Lisp error: (wrong-number-of-arguments length 0)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7264 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7265
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7266 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7267 This means that the function receives the wrong number of
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7268 arguments, zero, when it expects some other number of arguments. In
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7269 this case, one argument is expected, the argument being a list whose
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7270 length the function is measuring. (Note that @emph{one} list is
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7271 @emph{one} argument, even if the list has many elements inside it.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7272
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7273 The part of the error message that says @samp{length} is the name of
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7274 the function.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7275
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7276 @ignore
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7277 @code{length} is still a subroutine, but you need C-h f to discover that.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7278
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7279 In an earlier version:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7280 This is written with a special notation, @samp{#<subr},
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7281 that indicates that the function @code{length} is one of the primitive
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7282 functions written in C rather than in Emacs Lisp. (@samp{subr} is an
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7283 abbreviation for `subroutine'.) @xref{What Is a Function, , What Is a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7284 Function?, elisp , The GNU Emacs Lisp Reference Manual}, for more
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7285 about subroutines.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7286 @end ignore
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7287
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7288 @node nthcdr, nth, cons, car cdr & cons
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7289 @comment node-name, next, previous, up
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7290 @section @code{nthcdr}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7291 @findex nthcdr
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7292
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7293 The @code{nthcdr} function is associated with the @code{cdr} function.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7294 What it does is take the @sc{cdr} of a list repeatedly.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7295
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7296 If you take the @sc{cdr} of the list @code{(pine fir
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7297 oak maple)}, you will be returned the list @code{(fir oak maple)}. If you
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7298 repeat this on what was returned, you will be returned the list
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7299 @code{(oak maple)}. (Of course, repeated @sc{cdr}ing on the original
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7300 list will just give you the original @sc{cdr} since the function does
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7301 not change the list. You need to evaluate the @sc{cdr} of the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7302 @sc{cdr} and so on.) If you continue this, eventually you will be
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7303 returned an empty list, which in this case, instead of being shown as
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7304 @code{()} is shown as @code{nil}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7305
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7306 @need 1200
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7307 For review, here is a series of repeated @sc{cdr}s, the text following
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7308 the @samp{@result{}} shows what is returned.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7309
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7310 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7311 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7312 (cdr '(pine fir oak maple))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7313 @result{}(fir oak maple)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7314 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7315
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7316 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7317 (cdr '(fir oak maple))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7318 @result{} (oak maple)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7319 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7320
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7321 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7322 (cdr '(oak maple))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7323 @result{}(maple)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7324 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7325
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7326 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7327 (cdr '(maple))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7328 @result{} nil
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7329 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7330
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7331 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7332 (cdr 'nil)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7333 @result{} nil
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7334 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7335
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7336 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7337 (cdr ())
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7338 @result{} nil
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7339 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7340 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7341
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7342 @need 1200
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7343 You can also do several @sc{cdr}s without printing the values in
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7344 between, like this:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7345
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7346 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7347 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7348 (cdr (cdr '(pine fir oak maple)))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7349 @result{} (oak maple)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7350 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7351 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7352
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7353 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7354 In this example, the Lisp interpreter evaluates the innermost list first.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7355 The innermost list is quoted, so it just passes the list as it is to the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7356 innermost @code{cdr}. This @code{cdr} passes a list made up of the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7357 second and subsequent elements of the list to the outermost @code{cdr},
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7358 which produces a list composed of the third and subsequent elements of
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7359 the original list. In this example, the @code{cdr} function is repeated
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7360 and returns a list that consists of the original list without its
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7361 first two elements.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7362
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7363 The @code{nthcdr} function does the same as repeating the call to
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7364 @code{cdr}. In the following example, the argument 2 is passed to the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7365 function @code{nthcdr}, along with the list, and the value returned is
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7366 the list without its first two items, which is exactly the same
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7367 as repeating @code{cdr} twice on the list:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7368
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7369 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7370 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7371 (nthcdr 2 '(pine fir oak maple))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7372 @result{} (oak maple)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7373 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7374 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7375
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7376 @need 1200
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7377 Using the original four element list, we can see what happens when
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7378 various numeric arguments are passed to @code{nthcdr}, including 0, 1,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7379 and 5:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7380
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7381 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7382 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7383 ;; @r{Leave the list as it was.}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7384 (nthcdr 0 '(pine fir oak maple))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7385 @result{} (pine fir oak maple)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7386 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7387
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7388 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7389 ;; @r{Return a copy without the first element.}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7390 (nthcdr 1 '(pine fir oak maple))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7391 @result{} (fir oak maple)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7392 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7393
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7394 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7395 ;; @r{Return a copy of the list without three elements.}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7396 (nthcdr 3 '(pine fir oak maple))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7397 @result{} (maple)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7398 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7399
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7400 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7401 ;; @r{Return a copy lacking all four elements.}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7402 (nthcdr 4 '(pine fir oak maple))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7403 @result{} nil
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7404 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7405
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7406 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7407 ;; @r{Return a copy lacking all elements.}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7408 (nthcdr 5 '(pine fir oak maple))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7409 @result{} nil
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7410 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7411 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7412
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7413 @node nth, setcar, nthcdr, car cdr & cons
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7414 @comment node-name, next, previous, up
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7415 @section @code{nth}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7416 @findex nth
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7417
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7418 The @code{nthcdr} function takes the @sc{cdr} of a list repeatedly.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7419 The @code{nth} function takes the @sc{car} of the result returned by
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7420 @code{nthcdr}. It returns the Nth element of the list.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7421
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7422 @need 1500
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7423 Thus, if it were not defined in C for speed, the definition of
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7424 @code{nth} would be:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7425
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7426 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7427 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7428 (defun nth (n list)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7429 "Returns the Nth element of LIST.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7430 N counts from zero. If LIST is not that long, nil is returned."
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7431 (car (nthcdr n list)))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7432 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7433 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7434
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7435 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7436 (Originally, @code{nth} was defined in Emacs Lisp in @file{subr.el},
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7437 but its definition was redone in C in the 1980s.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7438
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7439 The @code{nth} function returns a single element of a list.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7440 This can be very convenient.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7441
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7442 Note that the elements are numbered from zero, not one. That is to
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7443 say, the first element of a list, its @sc{car} is the zeroth element.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7444 This is called `zero-based' counting and often bothers people who
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7445 are accustomed to the first element in a list being number one, which
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7446 is `one-based'.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7447
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7448 @need 1250
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7449 For example:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7450
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7451 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7452 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7453 (nth 0 '("one" "two" "three"))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7454 @result{} "one"
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7455
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7456 (nth 1 '("one" "two" "three"))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7457 @result{} "two"
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7458 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7459 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7460
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7461 It is worth mentioning that @code{nth}, like @code{nthcdr} and
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7462 @code{cdr}, does not change the original list---the function is
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7463 non-destructive. This is in sharp contrast to the @code{setcar} and
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7464 @code{setcdr} functions.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7465
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7466 @node setcar, setcdr, nth, car cdr & cons
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7467 @comment node-name, next, previous, up
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7468 @section @code{setcar}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7469 @findex setcar
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7470
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7471 As you might guess from their names, the @code{setcar} and @code{setcdr}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7472 functions set the @sc{car} or the @sc{cdr} of a list to a new value.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7473 They actually change the original list, unlike @code{car} and @code{cdr}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7474 which leave the original list as it was. One way to find out how this
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7475 works is to experiment. We will start with the @code{setcar} function.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7476
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7477 @need 1200
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7478 First, we can make a list and then set the value of a variable to the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7479 list, using the @code{setq} function. Here is a list of animals:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7480
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7481 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7482 (setq animals '(antelope giraffe lion tiger))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7483 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7484
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7485 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7486 If you are reading this in Info inside of GNU Emacs, you can evaluate
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7487 this expression in the usual fashion, by positioning the cursor after
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7488 the expression and typing @kbd{C-x C-e}. (I'm doing this right here
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7489 as I write this. This is one of the advantages of having the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7490 interpreter built into the computing environment. Incidentally, when
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7491 there is nothing on the line after the final parentheses, such as a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7492 comment, point can be on the next line. Thus, if your cursor is in
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7493 the first column of the next line, you do not need to move it.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7494 Indeed, Emacs permits any amount of white space after the final
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7495 parenthesis.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7496
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7497 @need 1200
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7498 When we evaluate the variable @code{animals}, we see that it is bound to
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7499 the list @code{(antelope giraffe lion tiger)}:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7500
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7501 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7502 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7503 animals
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7504 @result{} (antelope giraffe lion tiger)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7505 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7506 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7507
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7508 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7509 Put another way, the variable @code{animals} points to the list
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7510 @code{(antelope giraffe lion tiger)}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7511
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7512 Next, evaluate the function @code{setcar} while passing it two
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7513 arguments, the variable @code{animals} and the quoted symbol
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7514 @code{hippopotamus}; this is done by writing the three element list
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7515 @code{(setcar animals 'hippopotamus)} and then evaluating it in the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7516 usual fashion:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7517
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7518 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7519 (setcar animals 'hippopotamus)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7520 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7521
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7522 @need 1200
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7523 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7524 After evaluating this expression, evaluate the variable @code{animals}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7525 again. You will see that the list of animals has changed:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7526
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7527 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7528 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7529 animals
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7530 @result{} (hippopotamus giraffe lion tiger)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7531 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7532 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7533
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7534 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7535 The first element on the list, @code{antelope} is replaced by
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7536 @code{hippopotamus}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7537
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7538 So we can see that @code{setcar} did not add a new element to the list
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7539 as @code{cons} would have; it replaced @code{antelope} with
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7540 @code{hippopotamus}; it @emph{changed} the list.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7541
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7542 @node setcdr, cons Exercise, setcar, car cdr & cons
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7543 @comment node-name, next, previous, up
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7544 @section @code{setcdr}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7545 @findex setcdr
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7546
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7547 The @code{setcdr} function is similar to the @code{setcar} function,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7548 except that the function replaces the second and subsequent elements of
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7549 a list rather than the first element.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7550
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7551 (To see how to change the last element of a list, look ahead to
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7552 @ref{kill-new function, , The @code{kill-new} function}, which uses
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7553 the @code{nthcdr} and @code{setcdr} functions.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7554
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7555 @need 1200
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7556 To see how this works, set the value of the variable to a list of
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7557 domesticated animals by evaluating the following expression:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7558
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7559 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7560 (setq domesticated-animals '(horse cow sheep goat))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7561 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7562
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7563 @need 1200
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7564 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7565 If you now evaluate the list, you will be returned the list
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7566 @code{(horse cow sheep goat)}:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7567
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7568 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7569 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7570 domesticated-animals
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7571 @result{} (horse cow sheep goat)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7572 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7573 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7574
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7575 @need 1200
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7576 Next, evaluate @code{setcdr} with two arguments, the name of the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7577 variable which has a list as its value, and the list to which the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7578 @sc{cdr} of the first list will be set;
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7579
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7580 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7581 (setcdr domesticated-animals '(cat dog))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7582 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7583
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7584 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7585 If you evaluate this expression, the list @code{(cat dog)} will appear
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7586 in the echo area. This is the value returned by the function. The
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7587 result we are interested in is the ``side effect'', which we can see by
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7588 evaluating the variable @code{domesticated-animals}:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7589
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7590 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7591 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7592 domesticated-animals
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7593 @result{} (horse cat dog)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7594 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7595 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7596
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7597 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7598 Indeed, the list is changed from @code{(horse cow sheep goat)} to
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7599 @code{(horse cat dog)}. The @sc{cdr} of the list is changed from
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7600 @code{(cow sheep goat)} to @code{(cat dog)}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7601
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7602 @node cons Exercise, , setcdr, car cdr & cons
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7603 @section Exercise
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7604
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7605 Construct a list of four birds by evaluating several expressions with
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7606 @code{cons}. Find out what happens when you @code{cons} a list onto
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7607 itself. Replace the first element of the list of four birds with a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7608 fish. Replace the rest of that list with a list of other fish.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7609
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7610 @node Cutting & Storing Text, List Implementation, car cdr & cons, Top
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7611 @comment node-name, next, previous, up
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7612 @chapter Cutting and Storing Text
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7613 @cindex Cutting and storing text
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7614 @cindex Storing and cutting text
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7615 @cindex Killing text
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7616 @cindex Clipping text
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7617 @cindex Erasing text
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7618 @cindex Deleting text
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7619
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7620 Whenever you cut or clip text out of a buffer with a `kill' command in
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7621 GNU Emacs, it is stored in a list and you can bring it back with a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7622 `yank' command.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7623
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7624 (The use of the word `kill' in Emacs for processes which specifically
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7625 @emph{do not} destroy the values of the entities is an unfortunate
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7626 historical accident. A much more appropriate word would be `clip' since
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7627 that is what the kill commands do; they clip text out of a buffer and
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7628 put it into storage from which it can be brought back. I have often
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7629 been tempted to replace globally all occurrences of `kill' in the Emacs
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7630 sources with `clip' and all occurrences of `killed' with `clipped'.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7631
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7632 @menu
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7633 * Storing Text:: Text is stored in a list.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7634 * zap-to-char:: Cutting out text up to a character.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7635 * kill-region:: Cutting text out of a region.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7636 * copy-region-as-kill:: A definition for copying text.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7637 * Digression into C:: Minor note on C programming language macros.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7638 * defvar:: How to give a variable an initial value.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7639 * cons & search-fwd Review::
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7640 * search Exercises::
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7641 @end menu
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7642
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7643 @node Storing Text, zap-to-char, Cutting & Storing Text, Cutting & Storing Text
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7644 @ifnottex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7645 @unnumberedsec Storing Text in a List
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7646 @end ifnottex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7647
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7648 When text is cut out of a buffer, it is stored on a list. Successive
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7649 pieces of text are stored on the list successively, so the list might
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7650 look like this:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7651
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7652 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7653 ("a piece of text" "previous piece")
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7654 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7655
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7656 @need 1200
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7657 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7658 The function @code{cons} can be used to create a new list from a piece
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7659 of text (an `atom', to use the jargon) and an existing list, like
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7660 this:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7661
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7662 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7663 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7664 (cons "another piece"
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7665 '("a piece of text" "previous piece"))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7666 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7667 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7668
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7669 @need 1200
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7670 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7671 If you evaluate this expression, a list of three elements will appear in
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7672 the echo area:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7673
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7674 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7675 ("another piece" "a piece of text" "previous piece")
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7676 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7677
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7678 With the @code{car} and @code{nthcdr} functions, you can retrieve
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7679 whichever piece of text you want. For example, in the following code,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7680 @code{nthcdr 1 @dots{}} returns the list with the first item removed;
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7681 and the @code{car} returns the first element of that remainder---the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7682 second element of the original list:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7683
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7684 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7685 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7686 (car (nthcdr 1 '("another piece"
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7687 "a piece of text"
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7688 "previous piece")))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7689 @result{} "a piece of text"
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7690 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7691 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7692
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7693 The actual functions in Emacs are more complex than this, of course.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7694 The code for cutting and retrieving text has to be written so that
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7695 Emacs can figure out which element in the list you want---the first,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7696 second, third, or whatever. In addition, when you get to the end of
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7697 the list, Emacs should give you the first element of the list, rather
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7698 than nothing at all.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7699
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7700 The list that holds the pieces of text is called the @dfn{kill ring}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7701 This chapter leads up to a description of the kill ring and how it is
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7702 used by first tracing how the @code{zap-to-char} function works. This
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7703 function uses (or `calls') a function that invokes a function that
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7704 manipulates the kill ring. Thus, before reaching the mountains, we
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7705 climb the foothills.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7706
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7707 A subsequent chapter describes how text that is cut from the buffer is
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7708 retrieved. @xref{Yanking, , Yanking Text Back}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7709
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7710 @node zap-to-char, kill-region, Storing Text, Cutting & Storing Text
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7711 @comment node-name, next, previous, up
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7712 @section @code{zap-to-char}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7713 @findex zap-to-char
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7714
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7715 The @code{zap-to-char} function changed little between GNU Emacs
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7716 version 19 and GNU Emacs version 22. However, @code{zap-to-char}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7717 calls another function, @code{kill-region}, which enjoyed a major
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7718 rewrite.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7719
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7720 The @code{kill-region} function in Emacs 19 is complex, but does not
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7721 use code that is important at this time. We will skip it.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7722
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7723 The @code{kill-region} function in Emacs 22 is easier to read than the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7724 same function in Emacs 19 and introduces a very important concept,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7725 that of error handling. We will walk through the function.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7726
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7727 But first, let us look at the interactive @code{zap-to-char} function.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7728
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7729 @menu
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7730 * Complete zap-to-char:: The complete implementation.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7731 * zap-to-char interactive:: A three part interactive expression.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7732 * zap-to-char body:: A short overview.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7733 * search-forward:: How to search for a string.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7734 * progn:: The @code{progn} special form.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7735 * Summing up zap-to-char:: Using @code{point} and @code{search-forward}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7736 @end menu
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7737
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7738 @node Complete zap-to-char, zap-to-char interactive, zap-to-char, zap-to-char
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7739 @ifnottex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7740 @unnumberedsubsec The Complete @code{zap-to-char} Implementation
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7741 @end ifnottex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7742
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7743 The @code{zap-to-char} function removes the text in the region between
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7744 the location of the cursor (i.e., of point) up to and including the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7745 next occurrence of a specified character. The text that
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7746 @code{zap-to-char} removes is put in the kill ring; and it can be
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7747 retrieved from the kill ring by typing @kbd{C-y} (@code{yank}). If
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7748 the command is given an argument, it removes text through that number
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7749 of occurrences. Thus, if the cursor were at the beginning of this
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7750 sentence and the character were @samp{s}, @samp{Thus} would be
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7751 removed. If the argument were two, @samp{Thus, if the curs} would be
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7752 removed, up to and including the @samp{s} in @samp{cursor}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7753
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7754 If the specified character is not found, @code{zap-to-char} will say
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7755 ``Search failed'', tell you the character you typed, and not remove
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7756 any text.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7757
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7758 In order to determine how much text to remove, @code{zap-to-char} uses
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7759 a search function. Searches are used extensively in code that
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7760 manipulates text, and we will focus attention on them as well as on the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7761 deletion command.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7762
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7763 @ignore
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7764 @c GNU Emacs version 19
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7765 (defun zap-to-char (arg char) ; version 19 implementation
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7766 "Kill up to and including ARG'th occurrence of CHAR.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7767 Goes backward if ARG is negative; error if CHAR not found."
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7768 (interactive "*p\ncZap to char: ")
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7769 (kill-region (point)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7770 (progn
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7771 (search-forward
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7772 (char-to-string char) nil nil arg)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7773 (point))))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7774 @end ignore
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7775
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7776 @need 1250
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7777 Here is the complete text of the version 22 implementation of the function:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7778
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7779 @c GNU Emacs 22
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7780 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7781 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7782 (defun zap-to-char (arg char)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7783 "Kill up to and including ARG'th occurrence of CHAR.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7784 Case is ignored if `case-fold-search' is non-nil in the current buffer.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7785 Goes backward if ARG is negative; error if CHAR not found."
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7786 (interactive "p\ncZap to char: ")
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7787 (if (char-table-p translation-table-for-input)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7788 (setq char (or (aref translation-table-for-input char) char)))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7789 (kill-region (point) (progn
98525
b6395ec3de45 formatting fixes for new printed edition
Karl Berry <karl@gnu.org>
parents: 94896
diff changeset
7790 (search-forward (char-to-string char)
b6395ec3de45 formatting fixes for new printed edition
Karl Berry <karl@gnu.org>
parents: 94896
diff changeset
7791 nil nil arg)
83955
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7792 (point))))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7793 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7794 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7795
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7796 The documentation is thorough. You do need to know the jargon meaning
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7797 of the word `kill'.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7798
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7799 @node zap-to-char interactive, zap-to-char body, Complete zap-to-char, zap-to-char
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7800 @comment node-name, next, previous, up
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7801 @subsection The @code{interactive} Expression
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7802
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7803 @need 800
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7804 The interactive expression in the @code{zap-to-char} command looks like
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7805 this:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7806
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7807 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7808 (interactive "p\ncZap to char: ")
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7809 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7810
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7811 The part within quotation marks, @code{"p\ncZap to char:@: "}, specifies
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7812 two different things. First, and most simply, is the @samp{p}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7813 This part is separated from the next part by a newline, @samp{\n}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7814 The @samp{p} means that the first argument to the function will be
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7815 passed the value of a `processed prefix'. The prefix argument is
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7816 passed by typing @kbd{C-u} and a number, or @kbd{M-} and a number. If
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7817 the function is called interactively without a prefix, 1 is passed to
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7818 this argument.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7819
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7820 The second part of @code{"p\ncZap to char:@: "} is
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7821 @samp{cZap to char:@: }. In this part, the lower case @samp{c}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7822 indicates that @code{interactive} expects a prompt and that the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7823 argument will be a character. The prompt follows the @samp{c} and is
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7824 the string @samp{Zap to char:@: } (with a space after the colon to
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7825 make it look good).
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7826
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7827 What all this does is prepare the arguments to @code{zap-to-char} so they
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7828 are of the right type, and give the user a prompt.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7829
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7830 In a read-only buffer, the @code{zap-to-char} function copies the text
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7831 to the kill ring, but does not remove it. The echo area displays a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7832 message saying that the buffer is read-only. Also, the terminal may
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7833 beep or blink at you.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7834
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7835 @node zap-to-char body, search-forward, zap-to-char interactive, zap-to-char
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7836 @comment node-name, next, previous, up
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7837 @subsection The Body of @code{zap-to-char}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7838
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7839 The body of the @code{zap-to-char} function contains the code that
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7840 kills (that is, removes) the text in the region from the current
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7841 position of the cursor up to and including the specified character.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7842
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7843 The first part of the code looks like this:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7844
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7845 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7846 (if (char-table-p translation-table-for-input)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7847 (setq char (or (aref translation-table-for-input char) char)))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7848 (kill-region (point) (progn
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7849 (search-forward (char-to-string char) nil nil arg)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7850 (point)))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7851 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7852
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7853 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7854 @code{char-table-p} is an hitherto unseen function. It determines
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7855 whether its argument is a character table. When it is, it sets the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7856 character passed to @code{zap-to-char} to one of them, if that
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7857 character exists, or to the character itself. (This becomes important
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7858 for certain characters in non-European languages. The @code{aref}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7859 function extracts an element from an array. It is an array-specific
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7860 function that is not described in this document. @xref{Arrays, ,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7861 Arrays, elisp, The GNU Emacs Lisp Reference Manual}.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7862
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7863 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7864 @code{(point)} is the current position of the cursor.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7865
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7866 The next part of the code is an expression using @code{progn}. The body
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7867 of the @code{progn} consists of calls to @code{search-forward} and
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7868 @code{point}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7869
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7870 It is easier to understand how @code{progn} works after learning about
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7871 @code{search-forward}, so we will look at @code{search-forward} and
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7872 then at @code{progn}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7873
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7874 @node search-forward, progn, zap-to-char body, zap-to-char
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7875 @comment node-name, next, previous, up
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7876 @subsection The @code{search-forward} Function
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7877 @findex search-forward
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7878
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7879 The @code{search-forward} function is used to locate the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7880 zapped-for-character in @code{zap-to-char}. If the search is
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7881 successful, @code{search-forward} leaves point immediately after the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7882 last character in the target string. (In @code{zap-to-char}, the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7883 target string is just one character long. @code{zap-to-char} uses the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7884 function @code{char-to-string} to ensure that the computer treats that
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7885 character as a string.) If the search is backwards,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7886 @code{search-forward} leaves point just before the first character in
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7887 the target. Also, @code{search-forward} returns @code{t} for true.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7888 (Moving point is therefore a `side effect'.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7889
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7890 @need 1250
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7891 In @code{zap-to-char}, the @code{search-forward} function looks like this:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7892
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7893 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7894 (search-forward (char-to-string char) nil nil arg)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7895 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7896
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7897 The @code{search-forward} function takes four arguments:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7898
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7899 @enumerate
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7900 @item
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7901 The first argument is the target, what is searched for. This must be a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7902 string, such as @samp{"z"}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7903
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7904 As it happens, the argument passed to @code{zap-to-char} is a single
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7905 character. Because of the way computers are built, the Lisp
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7906 interpreter may treat a single character as being different from a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7907 string of characters. Inside the computer, a single character has a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7908 different electronic format than a string of one character. (A single
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7909 character can often be recorded in the computer using exactly one
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7910 byte; but a string may be longer, and the computer needs to be ready
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7911 for this.) Since the @code{search-forward} function searches for a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7912 string, the character that the @code{zap-to-char} function receives as
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7913 its argument must be converted inside the computer from one format to
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7914 the other; otherwise the @code{search-forward} function will fail.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7915 The @code{char-to-string} function is used to make this conversion.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7916
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7917 @item
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7918 The second argument bounds the search; it is specified as a position in
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7919 the buffer. In this case, the search can go to the end of the buffer,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7920 so no bound is set and the second argument is @code{nil}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7921
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7922 @item
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7923 The third argument tells the function what it should do if the search
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7924 fails---it can signal an error (and print a message) or it can return
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7925 @code{nil}. A @code{nil} as the third argument causes the function to
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7926 signal an error when the search fails.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7927
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7928 @item
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7929 The fourth argument to @code{search-forward} is the repeat count---how
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7930 many occurrences of the string to look for. This argument is optional
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7931 and if the function is called without a repeat count, this argument is
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7932 passed the value 1. If this argument is negative, the search goes
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7933 backwards.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7934 @end enumerate
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7935
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7936 @need 800
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7937 In template form, a @code{search-forward} expression looks like this:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7938
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7939 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7940 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7941 (search-forward "@var{target-string}"
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7942 @var{limit-of-search}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7943 @var{what-to-do-if-search-fails}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7944 @var{repeat-count})
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7945 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7946 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7947
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7948 We will look at @code{progn} next.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7949
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7950 @node progn, Summing up zap-to-char, search-forward, zap-to-char
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7951 @comment node-name, next, previous, up
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7952 @subsection The @code{progn} Special Form
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7953 @findex progn
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7954
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7955 @code{progn} is a special form that causes each of its arguments to be
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7956 evaluated in sequence and then returns the value of the last one. The
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7957 preceding expressions are evaluated only for the side effects they
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7958 perform. The values produced by them are discarded.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7959
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7960 @need 800
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7961 The template for a @code{progn} expression is very simple:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7962
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7963 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7964 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7965 (progn
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7966 @var{body}@dots{})
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7967 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7968 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7969
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7970 In @code{zap-to-char}, the @code{progn} expression has to do two things:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7971 put point in exactly the right position; and return the location of
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7972 point so that @code{kill-region} will know how far to kill to.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7973
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7974 The first argument to the @code{progn} is @code{search-forward}. When
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7975 @code{search-forward} finds the string, the function leaves point
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7976 immediately after the last character in the target string. (In this
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7977 case the target string is just one character long.) If the search is
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7978 backwards, @code{search-forward} leaves point just before the first
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7979 character in the target. The movement of point is a side effect.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7980
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7981 The second and last argument to @code{progn} is the expression
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7982 @code{(point)}. This expression returns the value of point, which in
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7983 this case will be the location to which it has been moved by
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7984 @code{search-forward}. (In the source, a line that tells the function
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7985 to go to the previous character, if it is going forward, was commented
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7986 out in 1999; I don't remember whether that feature or mis-feature was
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7987 ever a part of the distributed source.) The value of @code{point} is
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7988 returned by the @code{progn} expression and is passed to
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7989 @code{kill-region} as @code{kill-region}'s second argument.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7990
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7991 @node Summing up zap-to-char, , progn, zap-to-char
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7992 @comment node-name, next, previous, up
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7993 @subsection Summing up @code{zap-to-char}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7994
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7995 Now that we have seen how @code{search-forward} and @code{progn} work,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7996 we can see how the @code{zap-to-char} function works as a whole.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7997
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7998 The first argument to @code{kill-region} is the position of the cursor
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7999 when the @code{zap-to-char} command is given---the value of point at
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8000 that time. Within the @code{progn}, the search function then moves
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8001 point to just after the zapped-to-character and @code{point} returns the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8002 value of this location. The @code{kill-region} function puts together
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8003 these two values of point, the first one as the beginning of the region
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8004 and the second one as the end of the region, and removes the region.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8005
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8006 The @code{progn} special form is necessary because the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8007 @code{kill-region} command takes two arguments; and it would fail if
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8008 @code{search-forward} and @code{point} expressions were written in
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8009 sequence as two additional arguments. The @code{progn} expression is
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8010 a single argument to @code{kill-region} and returns the one value that
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8011 @code{kill-region} needs for its second argument.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8012
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8013 @node kill-region, copy-region-as-kill, zap-to-char, Cutting & Storing Text
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8014 @comment node-name, next, previous, up
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8015 @section @code{kill-region}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8016 @findex kill-region
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8017
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8018 The @code{zap-to-char} function uses the @code{kill-region} function.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8019 This function clips text from a region and copies that text to
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8020 the kill ring, from which it may be retrieved.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8021
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8022 @ignore
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8023 GNU Emacs 22:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8024
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8025 (defun kill-region (beg end &optional yank-handler)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8026 "Kill (\"cut\") text between point and mark.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8027 This deletes the text from the buffer and saves it in the kill ring.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8028 The command \\[yank] can retrieve it from there.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8029 \(If you want to kill and then yank immediately, use \\[kill-ring-save].)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8030
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8031 If you want to append the killed region to the last killed text,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8032 use \\[append-next-kill] before \\[kill-region].
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8033
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8034 If the buffer is read-only, Emacs will beep and refrain from deleting
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8035 the text, but put the text in the kill ring anyway. This means that
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8036 you can use the killing commands to copy text from a read-only buffer.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8037
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8038 This is the primitive for programs to kill text (as opposed to deleting it).
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8039 Supply two arguments, character positions indicating the stretch of text
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8040 to be killed.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8041 Any command that calls this function is a \"kill command\".
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8042 If the previous command was also a kill command,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8043 the text killed this time appends to the text killed last time
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8044 to make one entry in the kill ring.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8045
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8046 In Lisp code, optional third arg YANK-HANDLER, if non-nil,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8047 specifies the yank-handler text property to be set on the killed
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8048 text. See `insert-for-yank'."
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8049 ;; Pass point first, then mark, because the order matters
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8050 ;; when calling kill-append.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8051 (interactive (list (point) (mark)))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8052 (unless (and beg end)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8053 (error "The mark is not set now, so there is no region"))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8054 (condition-case nil
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8055 (let ((string (filter-buffer-substring beg end t)))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8056 (when string ;STRING is nil if BEG = END
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8057 ;; Add that string to the kill ring, one way or another.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8058 (if (eq last-command 'kill-region)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8059 (kill-append string (< end beg) yank-handler)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8060 (kill-new string nil yank-handler)))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8061 (when (or string (eq last-command 'kill-region))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8062 (setq this-command 'kill-region))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8063 nil)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8064 ((buffer-read-only text-read-only)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8065 ;; The code above failed because the buffer, or some of the characters
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8066 ;; in the region, are read-only.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8067 ;; We should beep, in case the user just isn't aware of this.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8068 ;; However, there's no harm in putting
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8069 ;; the region's text in the kill ring, anyway.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8070 (copy-region-as-kill beg end)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8071 ;; Set this-command now, so it will be set even if we get an error.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8072 (setq this-command 'kill-region)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8073 ;; This should barf, if appropriate, and give us the correct error.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8074 (if kill-read-only-ok
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8075 (progn (message "Read only text copied to kill ring") nil)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8076 ;; Signal an error if the buffer is read-only.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8077 (barf-if-buffer-read-only)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8078 ;; If the buffer isn't read-only, the text is.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8079 (signal 'text-read-only (list (current-buffer)))))))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8080 @end ignore
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8081
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8082 The Emacs 22 version of that function uses @code{condition-case} and
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8083 @code{copy-region-as-kill}, both of which we will explain.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8084 @code{condition-case} is an important special form.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8085
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8086 In essence, the @code{kill-region} function calls
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8087 @code{condition-case}, which takes three arguments. In this function,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8088 the first argument does nothing. The second argument contains the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8089 code that does the work when all goes well. The third argument
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8090 contains the code that is called in the event of an error.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8091
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8092 @menu
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8093 * Complete kill-region:: The function definition.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8094 * condition-case:: Dealing with a problem.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8095 * Lisp macro::
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8096 @end menu
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8097
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8098 @node Complete kill-region, condition-case, kill-region, kill-region
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8099 @ifnottex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8100 @unnumberedsubsec The Complete @code{kill-region} Definition
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8101 @end ifnottex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8102
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8103 @need 1200
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8104 We will go through the @code{condition-case} code in a moment. First,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8105 let us look at the definition of @code{kill-region}, with comments
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8106 added:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8107
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8108 @c GNU Emacs 22:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8109 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8110 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8111 (defun kill-region (beg end)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8112 "Kill (\"cut\") text between point and mark.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8113 This deletes the text from the buffer and saves it in the kill ring.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8114 The command \\[yank] can retrieve it from there. @dots{} "
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8115 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8116
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8117 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8118 ;; @bullet{} Since order matters, pass point first.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8119 (interactive (list (point) (mark)))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8120 ;; @bullet{} And tell us if we cannot cut the text.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8121 ;; `unless' is an `if' without a then-part.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8122 (unless (and beg end)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8123 (error "The mark is not set now, so there is no region"))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8124 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8125
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8126 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8127 ;; @bullet{} `condition-case' takes three arguments.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8128 ;; If the first argument is nil, as it is here,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8129 ;; information about the error signal is not
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8130 ;; stored for use by another function.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8131 (condition-case nil
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8132 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8133
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8134 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8135 ;; @bullet{} The second argument to `condition-case' tells the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8136 ;; Lisp interpreter what to do when all goes well.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8137 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8138
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8139 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8140 ;; It starts with a `let' function that extracts the string
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8141 ;; and tests whether it exists. If so (that is what the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8142 ;; `when' checks), it calls an `if' function that determines
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8143 ;; whether the previous command was another call to
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8144 ;; `kill-region'; if it was, then the new text is appended to
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8145 ;; the previous text; if not, then a different function,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8146 ;; `kill-new', is called.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8147 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8148
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8149 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8150 ;; The `kill-append' function concatenates the new string and
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8151 ;; the old. The `kill-new' function inserts text into a new
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8152 ;; item in the kill ring.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8153 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8154
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8155 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8156 ;; `when' is an `if' without an else-part. The second `when'
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8157 ;; again checks whether the current string exists; in
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8158 ;; addition, it checks whether the previous command was
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8159 ;; another call to `kill-region'. If one or the other
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8160 ;; condition is true, then it sets the current command to
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8161 ;; be `kill-region'.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8162 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8163 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8164 (let ((string (filter-buffer-substring beg end t)))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8165 (when string ;STRING is nil if BEG = END
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8166 ;; Add that string to the kill ring, one way or another.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8167 (if (eq last-command 'kill-region)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8168 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8169 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8170 ;; @minus{} `yank-handler' is an optional argument to
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8171 ;; `kill-region' that tells the `kill-append' and
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8172 ;; `kill-new' functions how deal with properties
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8173 ;; added to the text, such as `bold' or `italics'.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8174 (kill-append string (< end beg) yank-handler)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8175 (kill-new string nil yank-handler)))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8176 (when (or string (eq last-command 'kill-region))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8177 (setq this-command 'kill-region))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8178 nil)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8179 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8180
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8181 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8182 ;; @bullet{} The third argument to `condition-case' tells the interpreter
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8183 ;; what to do with an error.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8184 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8185 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8186 ;; The third argument has a conditions part and a body part.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8187 ;; If the conditions are met (in this case,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8188 ;; if text or buffer are read-only)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8189 ;; then the body is executed.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8190 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8191 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8192 ;; The first part of the third argument is the following:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8193 ((buffer-read-only text-read-only) ;; the if-part
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8194 ;; @dots{} the then-part
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8195 (copy-region-as-kill beg end)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8196 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8197 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8198 ;; Next, also as part of the then-part, set this-command, so
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8199 ;; it will be set in an error
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8200 (setq this-command 'kill-region)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8201 ;; Finally, in the then-part, send a message if you may copy
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8202 ;; the text to the kill ring without signally an error, but
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8203 ;; don't if you may not.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8204 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8205 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8206 (if kill-read-only-ok
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8207 (progn (message "Read only text copied to kill ring") nil)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8208 (barf-if-buffer-read-only)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8209 ;; If the buffer isn't read-only, the text is.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8210 (signal 'text-read-only (list (current-buffer)))))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8211 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8212 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8213
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8214 @ignore
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8215 @c v 21
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8216 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8217 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8218 (defun kill-region (beg end)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8219 "Kill between point and mark.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8220 The text is deleted but saved in the kill ring."
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8221 (interactive "r")
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8222 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8223
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8224 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8225 ;; 1. `condition-case' takes three arguments.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8226 ;; If the first argument is nil, as it is here,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8227 ;; information about the error signal is not
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8228 ;; stored for use by another function.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8229 (condition-case nil
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8230 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8231
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8232 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8233 ;; 2. The second argument to `condition-case'
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8234 ;; tells the Lisp interpreter what to do when all goes well.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8235 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8236
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8237 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8238 ;; The `delete-and-extract-region' function usually does the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8239 ;; work. If the beginning and ending of the region are both
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8240 ;; the same, then the variable `string' will be empty, or nil
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8241 (let ((string (delete-and-extract-region beg end)))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8242 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8243
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8244 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8245 ;; `when' is an `if' clause that cannot take an `else-part'.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8246 ;; Emacs normally sets the value of `last-command' to the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8247 ;; previous command.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8248 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8249 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8250 ;; `kill-append' concatenates the new string and the old.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8251 ;; `kill-new' inserts text into a new item in the kill ring.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8252 (when string
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8253 (if (eq last-command 'kill-region)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8254 ;; if true, prepend string
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8255 (kill-append string (< end beg))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8256 (kill-new string)))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8257 (setq this-command 'kill-region))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8258 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8259
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8260 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8261 ;; 3. The third argument to `condition-case' tells the interpreter
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8262 ;; what to do with an error.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8263 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8264 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8265 ;; The third argument has a conditions part and a body part.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8266 ;; If the conditions are met (in this case,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8267 ;; if text or buffer are read-only)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8268 ;; then the body is executed.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8269 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8270 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8271 ((buffer-read-only text-read-only) ;; this is the if-part
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8272 ;; then...
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8273 (copy-region-as-kill beg end)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8274 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8275 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8276 (if kill-read-only-ok ;; usually this variable is nil
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8277 (message "Read only text copied to kill ring")
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8278 ;; or else, signal an error if the buffer is read-only;
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8279 (barf-if-buffer-read-only)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8280 ;; and, in any case, signal that the text is read-only.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8281 (signal 'text-read-only (list (current-buffer)))))))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8282 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8283 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8284 @end ignore
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8285
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8286 @node condition-case, Lisp macro, Complete kill-region, kill-region
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8287 @comment node-name, next, previous, up
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8288 @subsection @code{condition-case}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8289 @findex condition-case
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8290
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8291 As we have seen earlier (@pxref{Making Errors, , Generate an Error
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8292 Message}), when the Emacs Lisp interpreter has trouble evaluating an
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8293 expression, it provides you with help; in the jargon, this is called
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8294 ``signaling an error''. Usually, the computer stops the program and
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8295 shows you a message.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8296
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8297 However, some programs undertake complicated actions. They should not
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8298 simply stop on an error. In the @code{kill-region} function, the most
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8299 likely error is that you will try to kill text that is read-only and
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8300 cannot be removed. So the @code{kill-region} function contains code
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8301 to handle this circumstance. This code, which makes up the body of
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8302 the @code{kill-region} function, is inside of a @code{condition-case}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8303 special form.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8304
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8305 @need 800
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8306 The template for @code{condition-case} looks like this:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8307
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8308 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8309 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8310 (condition-case
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8311 @var{var}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8312 @var{bodyform}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8313 @var{error-handler}@dots{})
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8314 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8315 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8316
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8317 The second argument, @var{bodyform}, is straightforward. The
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8318 @code{condition-case} special form causes the Lisp interpreter to
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8319 evaluate the code in @var{bodyform}. If no error occurs, the special
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8320 form returns the code's value and produces the side-effects, if any.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8321
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8322 In short, the @var{bodyform} part of a @code{condition-case}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8323 expression determines what should happen when everything works
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8324 correctly.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8325
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8326 However, if an error occurs, among its other actions, the function
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8327 generating the error signal will define one or more error condition
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8328 names.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8329
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8330 An error handler is the third argument to @code{condition case}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8331 An error handler has two parts, a @var{condition-name} and a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8332 @var{body}. If the @var{condition-name} part of an error handler
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8333 matches a condition name generated by an error, then the @var{body}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8334 part of the error handler is run.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8335
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8336 As you will expect, the @var{condition-name} part of an error handler
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8337 may be either a single condition name or a list of condition names.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8338
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8339 Also, a complete @code{condition-case} expression may contain more
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8340 than one error handler. When an error occurs, the first applicable
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8341 handler is run.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8342
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8343 Lastly, the first argument to the @code{condition-case} expression,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8344 the @var{var} argument, is sometimes bound to a variable that
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8345 contains information about the error. However, if that argument is
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8346 nil, as is the case in @code{kill-region}, that information is
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8347 discarded.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8348
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8349 @need 1200
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8350 In brief, in the @code{kill-region} function, the code
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8351 @code{condition-case} works like this:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8352
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8353 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8354 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8355 @var{If no errors}, @var{run only this code}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8356 @var{but}, @var{if errors}, @var{run this other code}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8357 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8358 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8359
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8360 @ignore
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8361 2006 Oct 24
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8362 In Emacs 22,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8363 copy-region-as-kill is short, 12 lines, and uses
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8364 filter-buffer-substring, which is longer, 39 lines
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8365 and has delete-and-extract-region in it.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8366 delete-and-extract-region is written in C.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8367
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8368 see Initializing a Variable with @code{defvar}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8369 this is line 8054
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8370 Initializing a Variable with @code{defvar} includes line 8350
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8371 @end ignore
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8372
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8373 @node Lisp macro, , condition-case, kill-region
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8374 @comment node-name, next, previous, up
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8375 @subsection Lisp macro
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8376 @cindex Macro, lisp
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8377 @cindex Lisp macro
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8378
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8379 The part of the @code{condition-case} expression that is evaluated in
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8380 the expectation that all goes well has a @code{when}. The code uses
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8381 @code{when} to determine whether the @code{string} variable points to
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8382 text that exists.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8383
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8384 A @code{when} expression is simply a programmers' convenience. It is
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8385 an @code{if} without the possibility of an else clause. In your mind,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8386 you can replace @code{when} with @code{if} and understand what goes
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8387 on. That is what the Lisp interpreter does.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8388
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8389 Technically speaking, @code{when} is a Lisp macro. A Lisp @dfn{macro}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8390 enables you to define new control constructs and other language
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8391 features. It tells the interpreter how to compute another Lisp
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8392 expression which will in turn compute the value. In this case, the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8393 `other expression' is an @code{if} expression.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8394
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8395 The @code{kill-region} function definition also has an @code{unless}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8396 macro; it is the converse of @code{when}. The @code{unless} macro is
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8397 an @code{if} without a then clause
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8398
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8399 For more about Lisp macros, see @ref{Macros, , Macros, elisp, The GNU
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8400 Emacs Lisp Reference Manual}. The C programming language also
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8401 provides macros. These are different, but also useful.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8402
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8403 @ignore
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8404 We will briefly look at C macros in
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8405 @ref{Digression into C}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8406 @end ignore
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8407
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8408 @need 1200
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8409 Regarding the @code{when} macro, in the @code{condition-case}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8410 expression, when the string has content, then another conditional
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8411 expression is executed. This is an @code{if} with both a then-part
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8412 and an else-part.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8413
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8414 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8415 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8416 (if (eq last-command 'kill-region)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8417 (kill-append string (< end beg) yank-handler)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8418 (kill-new string nil yank-handler))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8419 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8420 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8421
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8422 The then-part is evaluated if the previous command was another call to
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8423 @code{kill-region}; if not, the else-part is evaluated.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8424
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8425 @code{yank-handler} is an optional argument to @code{kill-region} that
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8426 tells the @code{kill-append} and @code{kill-new} functions how deal
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8427 with properties added to the text, such as `bold' or `italics'.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8428
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8429 @code{last-command} is a variable that comes with Emacs that we have
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8430 not seen before. Normally, whenever a function is executed, Emacs
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8431 sets the value of @code{last-command} to the previous command.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8432
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8433 @need 1200
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8434 In this segment of the definition, the @code{if} expression checks
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8435 whether the previous command was @code{kill-region}. If it was,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8436
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8437 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8438 (kill-append string (< end beg) yank-handler)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8439 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8440
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8441 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8442 concatenates a copy of the newly clipped text to the just previously
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8443 clipped text in the kill ring.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8444
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8445 @node copy-region-as-kill, Digression into C, kill-region, Cutting & Storing Text
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8446 @comment node-name, next, previous, up
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8447 @section @code{copy-region-as-kill}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8448 @findex copy-region-as-kill
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8449 @findex nthcdr
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8450
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8451 The @code{copy-region-as-kill} function copies a region of text from a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8452 buffer and (via either @code{kill-append} or @code{kill-new}) saves it
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8453 in the @code{kill-ring}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8454
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8455 If you call @code{copy-region-as-kill} immediately after a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8456 @code{kill-region} command, Emacs appends the newly copied text to the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8457 previously copied text. This means that if you yank back the text, you
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8458 get it all, from both this and the previous operation. On the other
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8459 hand, if some other command precedes the @code{copy-region-as-kill},
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8460 the function copies the text into a separate entry in the kill ring.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8461
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8462 @menu
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8463 * Complete copy-region-as-kill:: The complete function definition.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8464 * copy-region-as-kill body:: The body of @code{copy-region-as-kill}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8465 @end menu
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8466
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8467 @node Complete copy-region-as-kill, copy-region-as-kill body, copy-region-as-kill, copy-region-as-kill
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8468 @ifnottex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8469 @unnumberedsubsec The complete @code{copy-region-as-kill} function definition
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8470 @end ifnottex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8471
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8472 @need 1200
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8473 Here is the complete text of the version 22 @code{copy-region-as-kill}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8474 function:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8475
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8476 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8477 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8478 (defun copy-region-as-kill (beg end)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8479 "Save the region as if killed, but don't kill it.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8480 In Transient Mark mode, deactivate the mark.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8481 If `interprogram-cut-function' is non-nil, also save the text for a window
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8482 system cut and paste."
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8483 (interactive "r")
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8484 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8485 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8486 (if (eq last-command 'kill-region)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8487 (kill-append (filter-buffer-substring beg end) (< end beg))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8488 (kill-new (filter-buffer-substring beg end)))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8489 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8490 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8491 (if transient-mark-mode
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8492 (setq deactivate-mark t))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8493 nil)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8494 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8495 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8496
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8497 @need 800
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8498 As usual, this function can be divided into its component parts:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8499
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8500 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8501 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8502 (defun copy-region-as-kill (@var{argument-list})
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8503 "@var{documentation}@dots{}"
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8504 (interactive "r")
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8505 @var{body}@dots{})
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8506 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8507 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8508
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8509 The arguments are @code{beg} and @code{end} and the function is
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8510 interactive with @code{"r"}, so the two arguments must refer to the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8511 beginning and end of the region. If you have been reading though this
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8512 document from the beginning, understanding these parts of a function is
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8513 almost becoming routine.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8514
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8515 The documentation is somewhat confusing unless you remember that the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8516 word `kill' has a meaning different from usual. The `Transient Mark'
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8517 and @code{interprogram-cut-function} comments explain certain
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8518 side-effects.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8519
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8520 After you once set a mark, a buffer always contains a region. If you
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8521 wish, you can use Transient Mark mode to highlight the region
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8522 temporarily. (No one wants to highlight the region all the time, so
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8523 Transient Mark mode highlights it only at appropriate times. Many
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8524 people turn off Transient Mark mode, so the region is never
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8525 highlighted.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8526
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8527 Also, a windowing system allows you to copy, cut, and paste among
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8528 different programs. In the X windowing system, for example, the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8529 @code{interprogram-cut-function} function is @code{x-select-text},
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8530 which works with the windowing system's equivalent of the Emacs kill
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8531 ring.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8532
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8533 The body of the @code{copy-region-as-kill} function starts with an
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8534 @code{if} clause. What this clause does is distinguish between two
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8535 different situations: whether or not this command is executed
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8536 immediately after a previous @code{kill-region} command. In the first
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8537 case, the new region is appended to the previously copied text.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8538 Otherwise, it is inserted into the beginning of the kill ring as a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8539 separate piece of text from the previous piece.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8540
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8541 The last two lines of the function prevent the region from lighting up
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8542 if Transient Mark mode is turned on.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8543
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8544 The body of @code{copy-region-as-kill} merits discussion in detail.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8545
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8546 @node copy-region-as-kill body, , Complete copy-region-as-kill, copy-region-as-kill
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8547 @comment node-name, next, previous, up
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8548 @subsection The Body of @code{copy-region-as-kill}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8549
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8550 The @code{copy-region-as-kill} function works in much the same way as
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8551 the @code{kill-region} function. Both are written so that two or more
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8552 kills in a row combine their text into a single entry. If you yank
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8553 back the text from the kill ring, you get it all in one piece.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8554 Moreover, kills that kill forward from the current position of the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8555 cursor are added to the end of the previously copied text and commands
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8556 that copy text backwards add it to the beginning of the previously
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8557 copied text. This way, the words in the text stay in the proper
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8558 order.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8559
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8560 Like @code{kill-region}, the @code{copy-region-as-kill} function makes
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8561 use of the @code{last-command} variable that keeps track of the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8562 previous Emacs command.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8563
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8564 @menu
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8565 * last-command & this-command::
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8566 * kill-append function::
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8567 * kill-new function::
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8568 @end menu
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8569
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8570 @node last-command & this-command, kill-append function, copy-region-as-kill body, copy-region-as-kill body
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8571 @ifnottex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8572 @unnumberedsubsubsec @code{last-command} and @code{this-command}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8573 @end ifnottex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8574
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8575 Normally, whenever a function is executed, Emacs sets the value of
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8576 @code{this-command} to the function being executed (which in this case
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8577 would be @code{copy-region-as-kill}). At the same time, Emacs sets
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8578 the value of @code{last-command} to the previous value of
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8579 @code{this-command}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8580
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8581 In the first part of the body of the @code{copy-region-as-kill}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8582 function, an @code{if} expression determines whether the value of
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8583 @code{last-command} is @code{kill-region}. If so, the then-part of
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8584 the @code{if} expression is evaluated; it uses the @code{kill-append}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8585 function to concatenate the text copied at this call to the function
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8586 with the text already in the first element (the @sc{car}) of the kill
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8587 ring. On the other hand, if the value of @code{last-command} is not
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8588 @code{kill-region}, then the @code{copy-region-as-kill} function
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8589 attaches a new element to the kill ring using the @code{kill-new}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8590 function.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8591
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8592 @need 1250
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8593 The @code{if} expression reads as follows; it uses @code{eq}:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8594
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8595 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8596 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8597 (if (eq last-command 'kill-region)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8598 ;; @r{then-part}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8599 (kill-append (filter-buffer-substring beg end) (< end beg))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8600 ;; @r{else-part}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8601 (kill-new (filter-buffer-substring beg end)))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8602 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8603 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8604
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8605 @findex filter-buffer-substring
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8606 (The @code{filter-buffer-substring} function returns a filtered
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8607 substring of the buffer, if any. Optionally---the arguments are not
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8608 here, so neither is done---the function may delete the initial text or
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8609 return the text without its properties; this function is a replacement
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8610 for the older @code{buffer-substring} function, which came before text
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8611 properties were implemented.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8612
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8613 @findex eq @r{(example of use)}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8614 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8615 The @code{eq} function tests whether its first argument is the same Lisp
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8616 object as its second argument. The @code{eq} function is similar to the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8617 @code{equal} function in that it is used to test for equality, but
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8618 differs in that it determines whether two representations are actually
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8619 the same object inside the computer, but with different names.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8620 @code{equal} determines whether the structure and contents of two
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8621 expressions are the same.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8622
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8623 If the previous command was @code{kill-region}, then the Emacs Lisp
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8624 interpreter calls the @code{kill-append} function
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8625
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8626 @node kill-append function, kill-new function, last-command & this-command, copy-region-as-kill body
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8627 @unnumberedsubsubsec The @code{kill-append} function
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8628 @findex kill-append
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8629
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8630 @need 800
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8631 The @code{kill-append} function looks like this:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8632
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8633 @c in GNU Emacs 22
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8634 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8635 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8636 (defun kill-append (string before-p &optional yank-handler)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8637 "Append STRING to the end of the latest kill in the kill ring.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8638 If BEFORE-P is non-nil, prepend STRING to the kill.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8639 @dots{} "
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8640 (let* ((cur (car kill-ring)))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8641 (kill-new (if before-p (concat string cur) (concat cur string))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8642 (or (= (length cur) 0)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8643 (equal yank-handler
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8644 (get-text-property 0 'yank-handler cur)))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8645 yank-handler)))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8646 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8647 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8648
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8649 @ignore
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8650 was:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8651 (defun kill-append (string before-p)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8652 "Append STRING to the end of the latest kill in the kill ring.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8653 If BEFORE-P is non-nil, prepend STRING to the kill.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8654 If `interprogram-cut-function' is set, pass the resulting kill to
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8655 it."
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8656 (kill-new (if before-p
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8657 (concat string (car kill-ring))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8658 (concat (car kill-ring) string))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8659 t))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8660 @end ignore
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8661
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8662 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8663 The @code{kill-append} function is fairly straightforward. It uses
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8664 the @code{kill-new} function, which we will discuss in more detail in
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8665 a moment.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8666
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8667 (Also, the function provides an optional argument called
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8668 @code{yank-handler}; when invoked, this argument tells the function
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8669 how to deal with properties added to the text, such as `bold' or
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8670 `italics'.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8671
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8672 @c !!! bug in GNU Emacs 22 version of kill-append ?
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8673 It has a @code{let*} function to set the value of the first element of
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8674 the kill ring to @code{cur}. (I do not know why the function does not
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8675 use @code{let} instead; only one value is set in the expression.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8676 Perhaps this is a bug that produces no problems?)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8677
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8678 Consider the conditional that is one of the two arguments to
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8679 @code{kill-new}. It uses @code{concat} to concatenate the new text to
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8680 the @sc{car} of the kill ring. Whether it prepends or appends the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8681 text depends on the results of an @code{if} expression:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8682
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8683 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8684 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8685 (if before-p ; @r{if-part}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8686 (concat string cur) ; @r{then-part}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8687 (concat cur string)) ; @r{else-part}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8688 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8689 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8690
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8691 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8692 If the region being killed is before the region that was killed in the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8693 last command, then it should be prepended before the material that was
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8694 saved in the previous kill; and conversely, if the killed text follows
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8695 what was just killed, it should be appended after the previous text.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8696 The @code{if} expression depends on the predicate @code{before-p} to
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8697 decide whether the newly saved text should be put before or after the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8698 previously saved text.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8699
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8700 The symbol @code{before-p} is the name of one of the arguments to
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8701 @code{kill-append}. When the @code{kill-append} function is
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8702 evaluated, it is bound to the value returned by evaluating the actual
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8703 argument. In this case, this is the expression @code{(< end beg)}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8704 This expression does not directly determine whether the killed text in
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8705 this command is located before or after the kill text of the last
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8706 command; what it does is determine whether the value of the variable
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8707 @code{end} is less than the value of the variable @code{beg}. If it
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8708 is, it means that the user is most likely heading towards the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8709 beginning of the buffer. Also, the result of evaluating the predicate
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8710 expression, @code{(< end beg)}, will be true and the text will be
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8711 prepended before the previous text. On the other hand, if the value of
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8712 the variable @code{end} is greater than the value of the variable
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8713 @code{beg}, the text will be appended after the previous text.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8714
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8715 @need 800
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8716 When the newly saved text will be prepended, then the string with the new
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8717 text will be concatenated before the old text:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8718
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8719 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8720 (concat string cur)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8721 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8722
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8723 @need 1200
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8724 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8725 But if the text will be appended, it will be concatenated
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8726 after the old text:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8727
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8728 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8729 (concat cur string))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8730 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8731
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8732 To understand how this works, we first need to review the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8733 @code{concat} function. The @code{concat} function links together or
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8734 unites two strings of text. The result is a string. For example:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8735
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8736 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8737 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8738 (concat "abc" "def")
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8739 @result{} "abcdef"
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8740 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8741
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8742 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8743 (concat "new "
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8744 (car '("first element" "second element")))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8745 @result{} "new first element"
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8746
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8747 (concat (car
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8748 '("first element" "second element")) " modified")
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8749 @result{} "first element modified"
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8750 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8751 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8752
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8753 We can now make sense of @code{kill-append}: it modifies the contents
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8754 of the kill ring. The kill ring is a list, each element of which is
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8755 saved text. The @code{kill-append} function uses the @code{kill-new}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8756 function which in turn uses the @code{setcar} function.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8757
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8758 @node kill-new function, , kill-append function, copy-region-as-kill body
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8759 @unnumberedsubsubsec The @code{kill-new} function
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8760 @findex kill-new
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8761
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8762 @c in GNU Emacs 22, additional documentation to kill-new:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8763 @ignore
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8764 Optional third arguments YANK-HANDLER controls how the STRING is later
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8765 inserted into a buffer; see `insert-for-yank' for details.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8766 When a yank handler is specified, STRING must be non-empty (the yank
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8767 handler, if non-nil, is stored as a `yank-handler' text property on STRING).
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8768
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8769 When the yank handler has a non-nil PARAM element, the original STRING
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8770 argument is not used by `insert-for-yank'. However, since Lisp code
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8771 may access and use elements from the kill ring directly, the STRING
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8772 argument should still be a \"useful\" string for such uses."
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8773 @end ignore
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8774 @need 1200
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8775 The @code{kill-new} function looks like this:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8776
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8777 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8778 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8779 (defun kill-new (string &optional replace yank-handler)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8780 "Make STRING the latest kill in the kill ring.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8781 Set `kill-ring-yank-pointer' to point to it.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8782
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8783 If `interprogram-cut-function' is non-nil, apply it to STRING.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8784 Optional second argument REPLACE non-nil means that STRING will replace
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8785 the front of the kill ring, rather than being added to the list.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8786 @dots{}"
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8787 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8788 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8789 (if (> (length string) 0)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8790 (if yank-handler
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8791 (put-text-property 0 (length string)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8792 'yank-handler yank-handler string))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8793 (if yank-handler
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8794 (signal 'args-out-of-range
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8795 (list string "yank-handler specified for empty string"))))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8796 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8797 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8798 (if (fboundp 'menu-bar-update-yank-menu)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8799 (menu-bar-update-yank-menu string (and replace (car kill-ring))))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8800 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8801 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8802 (if (and replace kill-ring)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8803 (setcar kill-ring string)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8804 (push string kill-ring)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8805 (if (> (length kill-ring) kill-ring-max)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8806 (setcdr (nthcdr (1- kill-ring-max) kill-ring) nil)))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8807 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8808 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8809 (setq kill-ring-yank-pointer kill-ring)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8810 (if interprogram-cut-function
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8811 (funcall interprogram-cut-function string (not replace))))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8812 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8813 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8814 @ignore
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8815 was:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8816 (defun kill-new (string &optional replace)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8817 "Make STRING the latest kill in the kill ring.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8818 Set the kill-ring-yank pointer to point to it.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8819 If `interprogram-cut-function' is non-nil, apply it to STRING.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8820 Optional second argument REPLACE non-nil means that STRING will replace
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8821 the front of the kill ring, rather than being added to the list."
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8822 (and (fboundp 'menu-bar-update-yank-menu)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8823 (menu-bar-update-yank-menu string (and replace (car kill-ring))))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8824 (if (and replace kill-ring)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8825 (setcar kill-ring string)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8826 (setq kill-ring (cons string kill-ring))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8827 (if (> (length kill-ring) kill-ring-max)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8828 (setcdr (nthcdr (1- kill-ring-max) kill-ring) nil)))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8829 (setq kill-ring-yank-pointer kill-ring)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8830 (if interprogram-cut-function
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8831 (funcall interprogram-cut-function string (not replace))))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8832 @end ignore
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8833
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8834 (Notice that the function is not interactive.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8835
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8836 As usual, we can look at this function in parts.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8837
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8838 The function definition has an optional @code{yank-handler} argument,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8839 which when invoked tells the function how to deal with properties
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8840 added to the text, such as `bold' or `italics'. We will skip that.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8841
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8842 @need 1200
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8843 The first line of the documentation makes sense:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8844
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8845 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8846 Make STRING the latest kill in the kill ring.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8847 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8848
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8849 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8850 Let's skip over the rest of the documentation for the moment.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8851
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8852 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8853 Also, let's skip over the initial @code{if} expression and those lines
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8854 of code involving @code{menu-bar-update-yank-menu}. We will explain
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8855 them below.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8856
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8857 @need 1200
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8858 The critical lines are these:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8859
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8860 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8861 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8862 (if (and replace kill-ring)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8863 ;; @r{then}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8864 (setcar kill-ring string)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8865 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8866 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8867 ;; @r{else}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8868 (push string kill-ring)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8869 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8870 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8871 (setq kill-ring (cons string kill-ring))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8872 (if (> (length kill-ring) kill-ring-max)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8873 ;; @r{avoid overly long kill ring}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8874 (setcdr (nthcdr (1- kill-ring-max) kill-ring) nil)))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8875 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8876 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8877 (setq kill-ring-yank-pointer kill-ring)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8878 (if interprogram-cut-function
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8879 (funcall interprogram-cut-function string (not replace))))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8880 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8881 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8882
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8883 The conditional test is @w{@code{(and replace kill-ring)}}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8884 This will be true when two conditions are met: the kill ring has
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8885 something in it, and the @code{replace} variable is true.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8886
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8887 @need 1250
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8888 When the @code{kill-append} function sets @code{replace} to be true
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8889 and when the kill ring has at least one item in it, the @code{setcar}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8890 expression is executed:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8891
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8892 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8893 (setcar kill-ring string)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8894 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8895
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8896 The @code{setcar} function actually changes the first element of the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8897 @code{kill-ring} list to the value of @code{string}. It replaces the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8898 first element.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8899
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8900 @need 1250
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8901 On the other hand, if the kill ring is empty, or replace is false, the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8902 else-part of the condition is executed:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8903
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8904 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8905 (push string kill-ring)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8906 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8907
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8908 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8909 @need 1250
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8910 @code{push} puts its first argument onto the second. It is similar to
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8911 the older
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8912
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8913 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8914 (setq kill-ring (cons string kill-ring))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8915 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8916
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8917 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8918 @need 1250
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8919 or the newer
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8920
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8921 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8922 (add-to-list kill-ring string)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8923 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8924
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8925 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8926 When it is false, the expression first constructs a new version of the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8927 kill ring by prepending @code{string} to the existing kill ring as a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8928 new element (that is what the @code{push} does). Then it executes a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8929 second @code{if} clause. This second @code{if} clause keeps the kill
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8930 ring from growing too long.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8931
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8932 Let's look at these two expressions in order.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8933
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8934 The @code{push} line of the else-part sets the new value of the kill
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8935 ring to what results from adding the string being killed to the old
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8936 kill ring.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8937
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8938 We can see how this works with an example.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8939
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8940 @need 800
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8941 First,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8942
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8943 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8944 (setq example-list '("here is a clause" "another clause"))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8945 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8946
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8947 @need 1200
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8948 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8949 After evaluating this expression with @kbd{C-x C-e}, you can evaluate
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8950 @code{example-list} and see what it returns:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8951
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8952 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8953 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8954 example-list
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8955 @result{} ("here is a clause" "another clause")
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8956 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8957 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8958
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8959 @need 1200
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8960 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8961 Now, we can add a new element on to this list by evaluating the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8962 following expression:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8963 @findex push, @r{example}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8964
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8965 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8966 (push "a third clause" example-list)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8967 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8968
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8969 @need 800
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8970 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8971 When we evaluate @code{example-list}, we find its value is:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8972
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8973 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8974 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8975 example-list
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8976 @result{} ("a third clause" "here is a clause" "another clause")
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8977 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8978 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8979
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8980 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8981 Thus, the third clause is added to the list by @code{push}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8982
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8983 @need 1200
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8984 Now for the second part of the @code{if} clause. This expression
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8985 keeps the kill ring from growing too long. It looks like this:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8986
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8987 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8988 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8989 (if (> (length kill-ring) kill-ring-max)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8990 (setcdr (nthcdr (1- kill-ring-max) kill-ring) nil))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8991 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8992 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8993
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8994 The code checks whether the length of the kill ring is greater than
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8995 the maximum permitted length. This is the value of
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8996 @code{kill-ring-max} (which is 60, by default). If the length of the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8997 kill ring is too long, then this code sets the last element of the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8998 kill ring to @code{nil}. It does this by using two functions,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8999 @code{nthcdr} and @code{setcdr}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9000
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9001 We looked at @code{setcdr} earlier (@pxref{setcdr, , @code{setcdr}}).
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9002 It sets the @sc{cdr} of a list, just as @code{setcar} sets the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9003 @sc{car} of a list. In this case, however, @code{setcdr} will not be
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9004 setting the @sc{cdr} of the whole kill ring; the @code{nthcdr}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9005 function is used to cause it to set the @sc{cdr} of the next to last
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9006 element of the kill ring---this means that since the @sc{cdr} of the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9007 next to last element is the last element of the kill ring, it will set
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9008 the last element of the kill ring.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9009
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9010 @findex nthcdr, @r{example}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9011 The @code{nthcdr} function works by repeatedly taking the @sc{cdr} of a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9012 list---it takes the @sc{cdr} of the @sc{cdr} of the @sc{cdr}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9013 @dots{} It does this @var{N} times and returns the results.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9014 (@xref{nthcdr, , @code{nthcdr}}.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9015
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9016 @findex setcdr, @r{example}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9017 Thus, if we had a four element list that was supposed to be three
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9018 elements long, we could set the @sc{cdr} of the next to last element
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9019 to @code{nil}, and thereby shorten the list. (If you set the last
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9020 element to some other value than @code{nil}, which you could do, then
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9021 you would not have shortened the list. @xref{setcdr, ,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9022 @code{setcdr}}.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9023
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9024 You can see shortening by evaluating the following three expressions
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9025 in turn. First set the value of @code{trees} to @code{(maple oak pine
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9026 birch)}, then set the @sc{cdr} of its second @sc{cdr} to @code{nil}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9027 and then find the value of @code{trees}:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9028
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9029 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9030 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9031 (setq trees '(maple oak pine birch))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9032 @result{} (maple oak pine birch)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9033 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9034
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9035 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9036 (setcdr (nthcdr 2 trees) nil)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9037 @result{} nil
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9038
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9039 trees
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9040 @result{} (maple oak pine)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9041 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9042 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9043
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9044 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9045 (The value returned by the @code{setcdr} expression is @code{nil} since
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9046 that is what the @sc{cdr} is set to.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9047
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9048 To repeat, in @code{kill-new}, the @code{nthcdr} function takes the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9049 @sc{cdr} a number of times that is one less than the maximum permitted
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9050 size of the kill ring and @code{setcdr} sets the @sc{cdr} of that
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9051 element (which will be the rest of the elements in the kill ring) to
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9052 @code{nil}. This prevents the kill ring from growing too long.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9053
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9054 @need 800
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9055 The next to last expression in the @code{kill-new} function is
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9056
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9057 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9058 (setq kill-ring-yank-pointer kill-ring)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9059 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9060
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9061 The @code{kill-ring-yank-pointer} is a global variable that is set to be
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9062 the @code{kill-ring}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9063
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9064 Even though the @code{kill-ring-yank-pointer} is called a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9065 @samp{pointer}, it is a variable just like the kill ring. However, the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9066 name has been chosen to help humans understand how the variable is used.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9067
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9068 @need 1200
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9069 Now, to return to an early expression in the body of the function:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9070
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9071 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9072 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9073 (if (fboundp 'menu-bar-update-yank-menu)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9074 (menu-bar-update-yank-menu string (and replace (car kill-ring))))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9075 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9076 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9077
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9078 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9079 It starts with an @code{if} expression
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9080
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9081 In this case, the expression tests first to see whether
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9082 @code{menu-bar-update-yank-menu} exists as a function, and if so,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9083 calls it. The @code{fboundp} function returns true if the symbol it
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9084 is testing has a function definition that `is not void'. If the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9085 symbol's function definition were void, we would receive an error
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9086 message, as we did when we created errors intentionally (@pxref{Making
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9087 Errors, , Generate an Error Message}).
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9088
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9089 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9090 The then-part contains an expression whose first element is the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9091 function @code{and}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9092
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9093 @findex and
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9094 The @code{and} special form evaluates each of its arguments until one
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9095 of the arguments returns a value of @code{nil}, in which case the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9096 @code{and} expression returns @code{nil}; however, if none of the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9097 arguments returns a value of @code{nil}, the value resulting from
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9098 evaluating the last argument is returned. (Since such a value is not
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9099 @code{nil}, it is considered true in Emacs Lisp.) In other words, an
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9100 @code{and} expression returns a true value only if all its arguments
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9101 are true. (@xref{Second Buffer Related Review}.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9102
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9103 The expression determines whether the second argument to
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9104 @code{menu-bar-update-yank-menu} is true or not.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9105 @ignore
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9106 ;; If we're supposed to be extending an existing string, and that
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9107 ;; string really is at the front of the menu, then update it in place.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9108 @end ignore
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9109
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9110 @code{menu-bar-update-yank-menu} is one of the functions that make it
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9111 possible to use the `Select and Paste' menu in the Edit item of a menu
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9112 bar; using a mouse, you can look at the various pieces of text you
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9113 have saved and select one piece to paste.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9114
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9115 The last expression in the @code{kill-new} function adds the newly
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9116 copied string to whatever facility exists for copying and pasting
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9117 among different programs running in a windowing system. In the X
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9118 Windowing system, for example, the @code{x-select-text} function takes
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9119 the string and stores it in memory operated by X. You can paste the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9120 string in another program, such as an Xterm.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9121
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9122 @need 1200
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9123 The expression looks like this:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9124
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9125 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9126 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9127 (if interprogram-cut-function
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9128 (funcall interprogram-cut-function string (not replace))))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9129 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9130 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9131
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9132 If an @code{interprogram-cut-function} exists, then Emacs executes
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9133 @code{funcall}, which in turn calls its first argument as a function
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9134 and passes the remaining arguments to it. (Incidentally, as far as I
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9135 can see, this @code{if} expression could be replaced by an @code{and}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9136 expression similar to the one in the first part of the function.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9137
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9138 We are not going to discuss windowing systems and other programs
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9139 further, but merely note that this is a mechanism that enables GNU
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9140 Emacs to work easily and well with other programs.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9141
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9142 This code for placing text in the kill ring, either concatenated with
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9143 an existing element or as a new element, leads us to the code for
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9144 bringing back text that has been cut out of the buffer---the yank
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9145 commands. However, before discussing the yank commands, it is better
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9146 to learn how lists are implemented in a computer. This will make
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9147 clear such mysteries as the use of the term `pointer'. But before
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9148 that, we will digress into C.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9149
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9150 @ignore
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9151 @c is this true in Emacs 22? Does not seems to be
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9152
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9153 (If the @w{@code{(< end beg))}}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9154 expression is true, @code{kill-append} prepends the string to the just
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9155 previously clipped text. For a detailed discussion, see
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9156 @ref{kill-append function, , The @code{kill-append} function}.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9157
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9158 If you then yank back the text, i.e., `paste' it, you get both
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9159 pieces of text at once. That way, if you delete two words in a row,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9160 and then yank them back, you get both words, in their proper order,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9161 with one yank. (The @w{@code{(< end beg))}} expression makes sure the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9162 order is correct.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9163
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9164 On the other hand, if the previous command is not @code{kill-region},
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9165 then the @code{kill-new} function is called, which adds the text to
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9166 the kill ring as the latest item, and sets the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9167 @code{kill-ring-yank-pointer} variable to point to it.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9168 @end ignore
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9169 @ignore
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9170
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9171 @c Evidently, changed for Emacs 22. The zap-to-char command does not
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9172 @c use the delete-and-extract-region function
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9173
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9174 2006 Oct 26, the Digression into C is now OK but should come after
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9175 copy-region-as-kill and filter-buffer-substring
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9176
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9177 2006 Oct 24
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9178 In Emacs 22,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9179 copy-region-as-kill is short, 12 lines, and uses
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9180 filter-buffer-substring, which is longer, 39 lines
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9181 and has delete-and-extract-region in it.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9182 delete-and-extract-region is written in C.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9183
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9184 see Initializing a Variable with @code{defvar}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9185 @end ignore
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9186
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9187 @node Digression into C, defvar, copy-region-as-kill, Cutting & Storing Text
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9188 @comment node-name, next, previous, up
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9189 @section Digression into C
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9190 @findex delete-and-extract-region
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9191 @cindex C, a digression into
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9192 @cindex Digression into C
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9193
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9194 The @code{copy-region-as-kill} function (@pxref{copy-region-as-kill, ,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9195 @code{copy-region-as-kill}}) uses the @code{filter-buffer-substring}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9196 function, which in turn uses the @code{delete-and-extract-region}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9197 function. It removes the contents of a region and you cannot get them
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9198 back.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9199
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9200 Unlike the other code discussed here, the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9201 @code{delete-and-extract-region} function is not written in Emacs
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9202 Lisp; it is written in C and is one of the primitives of the GNU Emacs
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9203 system. Since it is very simple, I will digress briefly from Lisp and
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9204 describe it here.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9205
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9206 @c GNU Emacs 22 in /usr/local/src/emacs/src/editfns.c
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9207 @c the DEFUN for buffer-substring-no-properties
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9208
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9209 @need 1500
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9210 Like many of the other Emacs primitives,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9211 @code{delete-and-extract-region} is written as an instance of a C
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9212 macro, a macro being a template for code. The complete macro looks
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9213 like this:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9214
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9215 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9216 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9217 DEFUN ("buffer-substring-no-properties", Fbuffer_substring_no_properties,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9218 Sbuffer_substring_no_properties, 2, 2, 0,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9219 doc: /* Return the characters of part of the buffer,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9220 without the text properties.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9221 The two arguments START and END are character positions;
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9222 they can be in either order. */)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9223 (start, end)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9224 Lisp_Object start, end;
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9225 @{
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9226 register int b, e;
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9227
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9228 validate_region (&start, &end);
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9229 b = XINT (start);
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9230 e = XINT (end);
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9231
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9232 return make_buffer_string (b, e, 0);
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9233 @}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9234 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9235 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9236
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9237 Without going into the details of the macro writing process, let me
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9238 point out that this macro starts with the word @code{DEFUN}. The word
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9239 @code{DEFUN} was chosen since the code serves the same purpose as
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9240 @code{defun} does in Lisp. (The @code{DEFUN} C macro is defined in
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9241 @file{emacs/src/lisp.h}.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9242
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9243 The word @code{DEFUN} is followed by seven parts inside of
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9244 parentheses:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9245
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9246 @itemize @bullet
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9247 @item
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9248 The first part is the name given to the function in Lisp,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9249 @code{delete-and-extract-region}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9250
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9251 @item
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9252 The second part is the name of the function in C,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9253 @code{Fdelete_and_extract_region}. By convention, it starts with
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9254 @samp{F}. Since C does not use hyphens in names, underscores are used
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9255 instead.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9256
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9257 @item
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9258 The third part is the name for the C constant structure that records
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9259 information on this function for internal use. It is the name of the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9260 function in C but begins with an @samp{S} instead of an @samp{F}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9261
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9262 @item
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9263 The fourth and fifth parts specify the minimum and maximum number of
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9264 arguments the function can have. This function demands exactly 2
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9265 arguments.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9266
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9267 @item
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9268 The sixth part is nearly like the argument that follows the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9269 @code{interactive} declaration in a function written in Lisp: a letter
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9270 followed, perhaps, by a prompt. The only difference from the Lisp is
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9271 when the macro is called with no arguments. Then you write a @code{0}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9272 (which is a `null string'), as in this macro.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9273
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9274 If you were to specify arguments, you would place them between
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9275 quotation marks. The C macro for @code{goto-char} includes
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9276 @code{"NGoto char: "} in this position to indicate that the function
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9277 expects a raw prefix, in this case, a numerical location in a buffer,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9278 and provides a prompt.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9279
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9280 @item
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9281 The seventh part is a documentation string, just like the one for a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9282 function written in Emacs Lisp, except that every newline must be
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9283 written explicitly as @samp{\n} followed by a backslash and carriage
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9284 return.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9285
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9286 @need 1000
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9287 Thus, the first two lines of documentation for @code{goto-char} are
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9288 written like this:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9289
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9290 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9291 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9292 "Set point to POSITION, a number or marker.\n\
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9293 Beginning of buffer is position (point-min), end is (point-max)."
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9294 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9295 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9296 @end itemize
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9297
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9298 @need 1200
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9299 In a C macro, the formal parameters come next, with a statement of
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9300 what kind of object they are, followed by what might be called the `body'
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9301 of the macro. For @code{delete-and-extract-region} the `body'
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9302 consists of the following four lines:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9303
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9304 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9305 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9306 validate_region (&start, &end);
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9307 if (XINT (start) == XINT (end))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9308 return build_string ("");
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9309 return del_range_1 (XINT (start), XINT (end), 1, 1);
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9310 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9311 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9312
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9313 The @code{validate_region} function checks whether the values
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9314 passed as the beginning and end of the region are the proper type and
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9315 are within range. If the beginning and end positions are the same,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9316 then return and empty string.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9317
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9318 The @code{del_range_1} function actually deletes the text. It is a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9319 complex function we will not look into. It updates the buffer and
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9320 does other things. However, it is worth looking at the two arguments
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9321 passed to @code{del_range}. These are @w{@code{XINT (start)}} and
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9322 @w{@code{XINT (end)}}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9323
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9324 As far as the C language is concerned, @code{start} and @code{end} are
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9325 two integers that mark the beginning and end of the region to be
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9326 deleted@footnote{More precisely, and requiring more expert knowledge
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9327 to understand, the two integers are of type `Lisp_Object', which can
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9328 also be a C union instead of an integer type.}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9329
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9330 In early versions of Emacs, these two numbers were thirty-two bits
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9331 long, but the code is slowly being generalized to handle other
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9332 lengths. Three of the available bits are used to specify the type of
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9333 information; the remaining bits are used as `content'.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9334
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9335 @samp{XINT} is a C macro that extracts the relevant number from the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9336 longer collection of bits; the three other bits are discarded.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9337
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9338 @need 800
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9339 The command in @code{delete-and-extract-region} looks like this:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9340
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9341 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9342 del_range_1 (XINT (start), XINT (end), 1, 1);
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9343 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9344
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9345 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9346 It deletes the region between the beginning position, @code{start},
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9347 and the ending position, @code{end}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9348
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9349 From the point of view of the person writing Lisp, Emacs is all very
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9350 simple; but hidden underneath is a great deal of complexity to make it
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9351 all work.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9352
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9353 @node defvar, cons & search-fwd Review, Digression into C, Cutting & Storing Text
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9354 @comment node-name, next, previous, up
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9355 @section Initializing a Variable with @code{defvar}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9356 @findex defvar
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9357 @cindex Initializing a variable
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9358 @cindex Variable initialization
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9359
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9360 @ignore
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9361 2006 Oct 24
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9362 In Emacs 22,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9363 copy-region-as-kill is short, 12 lines, and uses
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9364 filter-buffer-substring, which is longer, 39 lines
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9365 and has delete-and-extract-region in it.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9366 delete-and-extract-region is written in C.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9367
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9368 see Initializing a Variable with @code{defvar}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9369
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9370 @end ignore
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9371
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9372 The @code{copy-region-as-kill} function is written in Emacs Lisp. Two
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9373 functions within it, @code{kill-append} and @code{kill-new}, copy a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9374 region in a buffer and save it in a variable called the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9375 @code{kill-ring}. This section describes how the @code{kill-ring}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9376 variable is created and initialized using the @code{defvar} special
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9377 form.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9378
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9379 (Again we note that the term @code{kill-ring} is a misnomer. The text
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9380 that is clipped out of the buffer can be brought back; it is not a ring
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9381 of corpses, but a ring of resurrectable text.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9382
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9383 In Emacs Lisp, a variable such as the @code{kill-ring} is created and
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9384 given an initial value by using the @code{defvar} special form. The
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9385 name comes from ``define variable''.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9386
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9387 The @code{defvar} special form is similar to @code{setq} in that it sets
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9388 the value of a variable. It is unlike @code{setq} in two ways: first,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9389 it only sets the value of the variable if the variable does not already
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9390 have a value. If the variable already has a value, @code{defvar} does
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9391 not override the existing value. Second, @code{defvar} has a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9392 documentation string.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9393
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9394 (Another special form, @code{defcustom}, is designed for variables
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9395 that people customize. It has more features than @code{defvar}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9396 (@xref{defcustom, , Setting Variables with @code{defcustom}}.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9397
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9398 @menu
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9399 * See variable current value::
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9400 * defvar and asterisk::
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9401 @end menu
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9402
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9403 @node See variable current value, defvar and asterisk, defvar, defvar
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9404 @ifnottex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9405 @unnumberedsubsec Seeing the Current Value of a Variable
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9406 @end ifnottex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9407
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9408 You can see the current value of a variable, any variable, by using
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9409 the @code{describe-variable} function, which is usually invoked by
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9410 typing @kbd{C-h v}. If you type @kbd{C-h v} and then @code{kill-ring}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9411 (followed by @key{RET}) when prompted, you will see what is in your
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9412 current kill ring---this may be quite a lot! Conversely, if you have
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9413 been doing nothing this Emacs session except read this document, you
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9414 may have nothing in it. Also, you will see the documentation for
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9415 @code{kill-ring}:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9416
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9417 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9418 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9419 Documentation:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9420 List of killed text sequences.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9421 Since the kill ring is supposed to interact nicely with cut-and-paste
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9422 facilities offered by window systems, use of this variable should
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9423 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9424 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9425 interact nicely with `interprogram-cut-function' and
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9426 `interprogram-paste-function'. The functions `kill-new',
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9427 `kill-append', and `current-kill' are supposed to implement this
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9428 interaction; you may want to use them instead of manipulating the kill
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9429 ring directly.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9430 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9431 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9432
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9433 @need 800
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9434 The kill ring is defined by a @code{defvar} in the following way:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9435
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9436 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9437 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9438 (defvar kill-ring nil
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9439 "List of killed text sequences.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9440 @dots{}")
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9441 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9442 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9443
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9444 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9445 In this variable definition, the variable is given an initial value of
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9446 @code{nil}, which makes sense, since if you have saved nothing, you want
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9447 nothing back if you give a @code{yank} command. The documentation
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9448 string is written just like the documentation string of a @code{defun}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9449 As with the documentation string of the @code{defun}, the first line of
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9450 the documentation should be a complete sentence, since some commands,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9451 like @code{apropos}, print only the first line of documentation.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9452 Succeeding lines should not be indented; otherwise they look odd when
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9453 you use @kbd{C-h v} (@code{describe-variable}).
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9454
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9455 @node defvar and asterisk, , See variable current value, defvar
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9456 @subsection @code{defvar} and an asterisk
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9457 @findex defvar @r{for a user customizable variable}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9458 @findex defvar @r{with an asterisk}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9459
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9460 In the past, Emacs used the @code{defvar} special form both for
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9461 internal variables that you would not expect a user to change and for
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9462 variables that you do expect a user to change. Although you can still
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9463 use @code{defvar} for user customizable variables, please use
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9464 @code{defcustom} instead, since that special form provides a path into
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9465 the Customization commands. (@xref{defcustom, , Specifying Variables
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9466 using @code{defcustom}}.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9467
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9468 When you specified a variable using the @code{defvar} special form,
103732
17cc1a24f40a (defvar and asterisk): Minor rephrasing.
Glenn Morris <rgm@gnu.org>
parents: 103421
diff changeset
9469 you could distinguish a variable that a user might want to change from
17cc1a24f40a (defvar and asterisk): Minor rephrasing.
Glenn Morris <rgm@gnu.org>
parents: 103421
diff changeset
9470 others by typing an asterisk, @samp{*}, in the first column of its
17cc1a24f40a (defvar and asterisk): Minor rephrasing.
Glenn Morris <rgm@gnu.org>
parents: 103421
diff changeset
9471 documentation string. For example:
83955
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9472
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9473 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9474 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9475 (defvar shell-command-default-error-buffer nil
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9476 "*Buffer name for `shell-command' @dots{} error output.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9477 @dots{} ")
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9478 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9479 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9480
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9481 @findex set-variable
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9482 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9483 You could (and still can) use the @code{set-variable} command to
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9484 change the value of @code{shell-command-default-error-buffer}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9485 temporarily. However, options set using @code{set-variable} are set
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9486 only for the duration of your editing session. The new values are not
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9487 saved between sessions. Each time Emacs starts, it reads the original
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9488 value, unless you change the value within your @file{.emacs} file,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9489 either by setting it manually or by using @code{customize}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9490 @xref{Emacs Initialization, , Your @file{.emacs} File}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9491
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9492 For me, the major use of the @code{set-variable} command is to suggest
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9493 variables that I might want to set in my @file{.emacs} file. There
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9494 are now more than 700 such variables --- far too many to remember
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9495 readily. Fortunately, you can press @key{TAB} after calling the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9496 @code{M-x set-variable} command to see the list of variables.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9497 (@xref{Examining, , Examining and Setting Variables, emacs,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9498 The GNU Emacs Manual}.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9499
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9500 @need 1250
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9501 @node cons & search-fwd Review, search Exercises, defvar, Cutting & Storing Text
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9502 @comment node-name, next, previous, up
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9503 @section Review
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9504
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9505 Here is a brief summary of some recently introduced functions.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9506
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9507 @table @code
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9508 @item car
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9509 @itemx cdr
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9510 @code{car} returns the first element of a list; @code{cdr} returns the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9511 second and subsequent elements of a list.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9512
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9513 @need 1250
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9514 For example:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9515
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9516 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9517 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9518 (car '(1 2 3 4 5 6 7))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9519 @result{} 1
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9520 (cdr '(1 2 3 4 5 6 7))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9521 @result{} (2 3 4 5 6 7)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9522 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9523 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9524
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9525 @item cons
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9526 @code{cons} constructs a list by prepending its first argument to its
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9527 second argument.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9528
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9529 @need 1250
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9530 For example:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9531
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9532 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9533 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9534 (cons 1 '(2 3 4))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9535 @result{} (1 2 3 4)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9536 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9537 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9538
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9539 @item funcall
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9540 @code{funcall} evaluates its first argument as a function. It passes
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9541 its remaining arguments to its first argument.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9542
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9543 @item nthcdr
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9544 Return the result of taking @sc{cdr} `n' times on a list.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9545 @iftex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9546 The
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9547 @tex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9548 $n^{th}$
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9549 @end tex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9550 @code{cdr}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9551 @end iftex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9552 The `rest of the rest', as it were.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9553
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9554 @need 1250
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9555 For example:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9556
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9557 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9558 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9559 (nthcdr 3 '(1 2 3 4 5 6 7))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9560 @result{} (4 5 6 7)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9561 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9562 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9563
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9564 @item setcar
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9565 @itemx setcdr
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9566 @code{setcar} changes the first element of a list; @code{setcdr}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9567 changes the second and subsequent elements of a list.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9568
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9569 @need 1250
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9570 For example:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9571
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9572 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9573 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9574 (setq triple '(1 2 3))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9575
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9576 (setcar triple '37)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9577
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9578 triple
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9579 @result{} (37 2 3)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9580
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9581 (setcdr triple '("foo" "bar"))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9582
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9583 triple
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9584 @result{} (37 "foo" "bar")
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9585 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9586 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9587
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9588 @item progn
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9589 Evaluate each argument in sequence and then return the value of the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9590 last.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9591
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9592 @need 1250
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9593 For example:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9594
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9595 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9596 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9597 (progn 1 2 3 4)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9598 @result{} 4
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9599 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9600 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9601
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9602 @item save-restriction
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9603 Record whatever narrowing is in effect in the current buffer, if any,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9604 and restore that narrowing after evaluating the arguments.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9605
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9606 @item search-forward
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9607 Search for a string, and if the string is found, move point. With a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9608 regular expression, use the similar @code{re-search-forward}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9609 (@xref{Regexp Search, , Regular Expression Searches}, for an
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9610 explanation of regular expression patterns and searches.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9611
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9612 @need 1250
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9613 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9614 @code{search-forward} and @code{re-search-forward} take four
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9615 arguments:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9616
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9617 @enumerate
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9618 @item
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9619 The string or regular expression to search for.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9620
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9621 @item
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9622 Optionally, the limit of the search.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9623
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9624 @item
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9625 Optionally, what to do if the search fails, return @code{nil} or an
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9626 error message.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9627
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9628 @item
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9629 Optionally, how many times to repeat the search; if negative, the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9630 search goes backwards.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9631 @end enumerate
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9632
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9633 @item kill-region
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9634 @itemx delete-and-extract-region
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9635 @itemx copy-region-as-kill
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9636
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9637 @code{kill-region} cuts the text between point and mark from the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9638 buffer and stores that text in the kill ring, so you can get it back
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9639 by yanking.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9640
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9641 @code{copy-region-as-kill} copies the text between point and mark into
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9642 the kill ring, from which you can get it by yanking. The function
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9643 does not cut or remove the text from the buffer.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9644 @end table
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9645
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9646 @code{delete-and-extract-region} removes the text between point and
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9647 mark from the buffer and throws it away. You cannot get it back.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9648 (This is not an interactive command.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9649
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9650 @need 1500
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9651 @node search Exercises, , cons & search-fwd Review, Cutting & Storing Text
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9652 @section Searching Exercises
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9653
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9654 @itemize @bullet
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9655 @item
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9656 Write an interactive function that searches for a string. If the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9657 search finds the string, leave point after it and display a message
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9658 that says ``Found!''. (Do not use @code{search-forward} for the name
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9659 of this function; if you do, you will overwrite the existing version of
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9660 @code{search-forward} that comes with Emacs. Use a name such as
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9661 @code{test-search} instead.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9662
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9663 @item
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9664 Write a function that prints the third element of the kill ring in the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9665 echo area, if any; if the kill ring does not contain a third element,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9666 print an appropriate message.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9667 @end itemize
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9668
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9669 @node List Implementation, Yanking, Cutting & Storing Text, Top
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9670 @comment node-name, next, previous, up
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9671 @chapter How Lists are Implemented
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9672 @cindex Lists in a computer
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9673
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9674 In Lisp, atoms are recorded in a straightforward fashion; if the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9675 implementation is not straightforward in practice, it is, nonetheless,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9676 straightforward in theory. The atom @samp{rose}, for example, is
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9677 recorded as the four contiguous letters @samp{r}, @samp{o}, @samp{s},
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9678 @samp{e}. A list, on the other hand, is kept differently. The mechanism
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9679 is equally simple, but it takes a moment to get used to the idea. A
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9680 list is kept using a series of pairs of pointers. In the series, the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9681 first pointer in each pair points to an atom or to another list, and the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9682 second pointer in each pair points to the next pair, or to the symbol
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9683 @code{nil}, which marks the end of the list.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9684
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9685 A pointer itself is quite simply the electronic address of what is
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9686 pointed to. Hence, a list is kept as a series of electronic addresses.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9687
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9688 @menu
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9689 * Lists diagrammed::
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9690 * Symbols as Chest:: Exploring a powerful metaphor.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9691 * List Exercise::
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9692 @end menu
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9693
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9694 @node Lists diagrammed, Symbols as Chest, List Implementation, List Implementation
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9695 @ifnottex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9696 @unnumberedsec Lists diagrammed
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9697 @end ifnottex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9698
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9699 For example, the list @code{(rose violet buttercup)} has three elements,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9700 @samp{rose}, @samp{violet}, and @samp{buttercup}. In the computer, the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9701 electronic address of @samp{rose} is recorded in a segment of computer
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9702 memory along with the address that gives the electronic address of where
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9703 the atom @samp{violet} is located; and that address (the one that tells
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9704 where @samp{violet} is located) is kept along with an address that tells
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9705 where the address for the atom @samp{buttercup} is located.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9706
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9707 @need 1200
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9708 This sounds more complicated than it is and is easier seen in a diagram:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9709
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9710 @c clear print-postscript-figures
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9711 @c !!! cons-cell-diagram #1
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9712 @ifnottex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9713 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9714 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9715 ___ ___ ___ ___ ___ ___
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9716 |___|___|--> |___|___|--> |___|___|--> nil
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9717 | | |
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9718 | | |
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9719 --> rose --> violet --> buttercup
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9720 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9721 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9722 @end ifnottex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9723 @ifset print-postscript-figures
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9724 @sp 1
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9725 @tex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9726 @center @image{cons-1}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9727 %%%% old method of including an image
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9728 % \input /usr/local/lib/tex/inputs/psfig.tex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9729 % \centerline{\psfig{figure=/usr/local/lib/emacs/man/cons-1.eps}}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9730 % \catcode`\@=0 %
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9731 @end tex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9732 @sp 1
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9733 @end ifset
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9734 @ifclear print-postscript-figures
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9735 @iftex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9736 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9737 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9738 ___ ___ ___ ___ ___ ___
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9739 |___|___|--> |___|___|--> |___|___|--> nil
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9740 | | |
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9741 | | |
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9742 --> rose --> violet --> buttercup
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9743 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9744 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9745 @end iftex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9746 @end ifclear
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9747
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9748 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9749 In the diagram, each box represents a word of computer memory that
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9750 holds a Lisp object, usually in the form of a memory address. The boxes,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9751 i.e.@: the addresses, are in pairs. Each arrow points to what the address
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9752 is the address of, either an atom or another pair of addresses. The
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9753 first box is the electronic address of @samp{rose} and the arrow points
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9754 to @samp{rose}; the second box is the address of the next pair of boxes,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9755 the first part of which is the address of @samp{violet} and the second
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9756 part of which is the address of the next pair. The very last box
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9757 points to the symbol @code{nil}, which marks the end of the list.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9758
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9759 @need 1200
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9760 When a variable is set to a list with a function such as @code{setq},
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9761 it stores the address of the first box in the variable. Thus,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9762 evaluation of the expression
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9763
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9764 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9765 (setq bouquet '(rose violet buttercup))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9766 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9767
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9768 @need 1250
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9769 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9770 creates a situation like this:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9771
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9772 @c cons-cell-diagram #2
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9773 @ifnottex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9774 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9775 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9776 bouquet
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9777 |
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9778 | ___ ___ ___ ___ ___ ___
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9779 --> |___|___|--> |___|___|--> |___|___|--> nil
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9780 | | |
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9781 | | |
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9782 --> rose --> violet --> buttercup
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9783 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9784 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9785 @end ifnottex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9786 @ifset print-postscript-figures
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9787 @sp 1
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9788 @tex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9789 @center @image{cons-2}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9790 %%%% old method of including an image
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9791 % \input /usr/local/lib/tex/inputs/psfig.tex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9792 % \centerline{\psfig{figure=/usr/local/lib/emacs/man/cons-2.eps}}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9793 % \catcode`\@=0 %
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9794 @end tex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9795 @sp 1
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9796 @end ifset
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9797 @ifclear print-postscript-figures
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9798 @iftex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9799 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9800 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9801 bouquet
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9802 |
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9803 | ___ ___ ___ ___ ___ ___
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9804 --> |___|___|--> |___|___|--> |___|___|--> nil
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9805 | | |
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9806 | | |
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9807 --> rose --> violet --> buttercup
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9808 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9809 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9810 @end iftex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9811 @end ifclear
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9812
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9813 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9814 In this example, the symbol @code{bouquet} holds the address of the first
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9815 pair of boxes.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9816
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9817 @need 1200
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9818 This same list can be illustrated in a different sort of box notation
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9819 like this:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9820
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9821 @c cons-cell-diagram #2a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9822 @ifnottex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9823 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9824 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9825 bouquet
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9826 |
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9827 | -------------- --------------- ----------------
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9828 | | car | cdr | | car | cdr | | car | cdr |
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9829 -->| rose | o------->| violet | o------->| butter- | nil |
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9830 | | | | | | | cup | |
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9831 -------------- --------------- ----------------
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9832 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9833 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9834 @end ifnottex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9835 @ifset print-postscript-figures
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9836 @sp 1
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9837 @tex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9838 @center @image{cons-2a}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9839 %%%% old method of including an image
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9840 % \input /usr/local/lib/tex/inputs/psfig.tex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9841 % \centerline{\psfig{figure=/usr/local/lib/emacs/man/cons-2a.eps}}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9842 % \catcode`\@=0 %
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9843 @end tex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9844 @sp 1
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9845 @end ifset
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9846 @ifclear print-postscript-figures
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9847 @iftex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9848 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9849 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9850 bouquet
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9851 |
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9852 | -------------- --------------- ----------------
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9853 | | car | cdr | | car | cdr | | car | cdr |
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9854 -->| rose | o------->| violet | o------->| butter- | nil |
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9855 | | | | | | | cup | |
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9856 -------------- --------------- ----------------
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9857 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9858 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9859 @end iftex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9860 @end ifclear
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9861
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9862 (Symbols consist of more than pairs of addresses, but the structure of
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9863 a symbol is made up of addresses. Indeed, the symbol @code{bouquet}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9864 consists of a group of address-boxes, one of which is the address of
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9865 the printed word @samp{bouquet}, a second of which is the address of a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9866 function definition attached to the symbol, if any, a third of which
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9867 is the address of the first pair of address-boxes for the list
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9868 @code{(rose violet buttercup)}, and so on. Here we are showing that
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9869 the symbol's third address-box points to the first pair of
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9870 address-boxes for the list.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9871
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9872 If a symbol is set to the @sc{cdr} of a list, the list itself is not
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9873 changed; the symbol simply has an address further down the list. (In
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9874 the jargon, @sc{car} and @sc{cdr} are `non-destructive'.) Thus,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9875 evaluation of the following expression
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9876
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9877 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9878 (setq flowers (cdr bouquet))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9879 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9880
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9881 @need 800
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9882 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9883 produces this:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9884
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9885 @c cons-cell-diagram #3
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9886 @ifnottex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9887 @sp 1
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9888 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9889 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9890 bouquet flowers
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9891 | |
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9892 | ___ ___ | ___ ___ ___ ___
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9893 --> | | | --> | | | | | |
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9894 |___|___|----> |___|___|--> |___|___|--> nil
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9895 | | |
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9896 | | |
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9897 --> rose --> violet --> buttercup
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9898 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9899 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9900 @sp 1
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9901 @end ifnottex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9902 @ifset print-postscript-figures
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9903 @sp 1
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9904 @tex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9905 @center @image{cons-3}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9906 %%%% old method of including an image
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9907 % \input /usr/local/lib/tex/inputs/psfig.tex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9908 % \centerline{\psfig{figure=/usr/local/lib/emacs/man/cons-3.eps}}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9909 % \catcode`\@=0 %
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9910 @end tex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9911 @sp 1
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9912 @end ifset
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9913 @ifclear print-postscript-figures
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9914 @iftex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9915 @sp 1
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9916 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9917 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9918 bouquet flowers
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9919 | |
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9920 | ___ ___ | ___ ___ ___ ___
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9921 --> | | | --> | | | | | |
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9922 |___|___|----> |___|___|--> |___|___|--> nil
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9923 | | |
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9924 | | |
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9925 --> rose --> violet --> buttercup
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9926 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9927 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9928 @sp 1
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9929 @end iftex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9930 @end ifclear
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9931
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9932 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9933 The value of @code{flowers} is @code{(violet buttercup)}, which is
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9934 to say, the symbol @code{flowers} holds the address of the pair of
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9935 address-boxes, the first of which holds the address of @code{violet},
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9936 and the second of which holds the address of @code{buttercup}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9937
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9938 A pair of address-boxes is called a @dfn{cons cell} or @dfn{dotted
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9939 pair}. @xref{Cons Cell Type, , Cons Cell and List Types, elisp, The GNU Emacs Lisp
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9940 Reference Manual}, and @ref{Dotted Pair Notation, , Dotted Pair
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9941 Notation, elisp, The GNU Emacs Lisp Reference Manual}, for more
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9942 information about cons cells and dotted pairs.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9943
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9944 @need 1200
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9945 The function @code{cons} adds a new pair of addresses to the front of
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9946 a series of addresses like that shown above. For example, evaluating
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9947 the expression
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9948
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9949 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9950 (setq bouquet (cons 'lily bouquet))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9951 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9952
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9953 @need 1500
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9954 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9955 produces:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9956
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9957 @c cons-cell-diagram #4
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9958 @ifnottex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9959 @sp 1
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9960 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9961 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9962 bouquet flowers
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9963 | |
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9964 | ___ ___ ___ ___ | ___ ___ ___ ___
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9965 --> | | | | | | --> | | | | | |
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9966 |___|___|----> |___|___|----> |___|___|---->|___|___|--> nil
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9967 | | | |
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9968 | | | |
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9969 --> lily --> rose --> violet --> buttercup
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9970 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9971 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9972 @sp 1
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9973 @end ifnottex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9974 @ifset print-postscript-figures
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9975 @sp 1
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9976 @tex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9977 @center @image{cons-4}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9978 %%%% old method of including an image
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9979 % \input /usr/local/lib/tex/inputs/psfig.tex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9980 % \centerline{\psfig{figure=/usr/local/lib/emacs/man/cons-4.eps}}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9981 % \catcode`\@=0 %
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9982 @end tex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9983 @sp 1
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9984 @end ifset
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9985 @ifclear print-postscript-figures
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9986 @iftex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9987 @sp 1
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9988 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9989 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9990 bouquet flowers
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9991 | |
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9992 | ___ ___ ___ ___ | ___ ___ ___ ___
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9993 --> | | | | | | --> | | | | | |
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9994 |___|___|----> |___|___|----> |___|___|---->|___|___|--> nil
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9995 | | | |
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9996 | | | |
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9997 --> lily --> rose --> violet --> buttercup
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9998 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9999 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10000 @sp 1
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10001 @end iftex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10002 @end ifclear
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10003
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10004 @need 1200
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10005 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10006 However, this does not change the value of the symbol
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10007 @code{flowers}, as you can see by evaluating the following,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10008
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10009 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10010 (eq (cdr (cdr bouquet)) flowers)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10011 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10012
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10013 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10014 which returns @code{t} for true.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10015
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10016 Until it is reset, @code{flowers} still has the value
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10017 @code{(violet buttercup)}; that is, it has the address of the cons
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10018 cell whose first address is of @code{violet}. Also, this does not
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10019 alter any of the pre-existing cons cells; they are all still there.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10020
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10021 Thus, in Lisp, to get the @sc{cdr} of a list, you just get the address
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10022 of the next cons cell in the series; to get the @sc{car} of a list,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10023 you get the address of the first element of the list; to @code{cons} a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10024 new element on a list, you add a new cons cell to the front of the list.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10025 That is all there is to it! The underlying structure of Lisp is
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10026 brilliantly simple!
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10027
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10028 And what does the last address in a series of cons cells refer to? It
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10029 is the address of the empty list, of @code{nil}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10030
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10031 In summary, when a Lisp variable is set to a value, it is provided with
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10032 the address of the list to which the variable refers.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10033
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10034 @node Symbols as Chest, List Exercise, Lists diagrammed, List Implementation
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10035 @section Symbols as a Chest of Drawers
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10036 @cindex Symbols as a Chest of Drawers
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10037 @cindex Chest of Drawers, metaphor for a symbol
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10038 @cindex Drawers, Chest of, metaphor for a symbol
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10039
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10040 In an earlier section, I suggested that you might imagine a symbol as
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10041 being a chest of drawers. The function definition is put in one
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10042 drawer, the value in another, and so on. What is put in the drawer
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10043 holding the value can be changed without affecting the contents of the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10044 drawer holding the function definition, and vice-verse.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10045
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10046 Actually, what is put in each drawer is the address of the value or
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10047 function definition. It is as if you found an old chest in the attic,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10048 and in one of its drawers you found a map giving you directions to
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10049 where the buried treasure lies.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10050
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10051 (In addition to its name, symbol definition, and variable value, a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10052 symbol has a `drawer' for a @dfn{property list} which can be used to
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10053 record other information. Property lists are not discussed here; see
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10054 @ref{Property Lists, , Property Lists, elisp, The GNU Emacs Lisp
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10055 Reference Manual}.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10056
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10057 @need 1500
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10058 Here is a fanciful representation:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10059
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10060 @c chest-of-drawers diagram
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10061 @ifnottex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10062 @sp 1
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10063 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10064 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10065 Chest of Drawers Contents of Drawers
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10066
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10067 __ o0O0o __
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10068 / \
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10069 ---------------------
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10070 | directions to | [map to]
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10071 | symbol name | bouquet
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10072 | |
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10073 +---------------------+
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10074 | directions to |
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10075 | symbol definition | [none]
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10076 | |
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10077 +---------------------+
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10078 | directions to | [map to]
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10079 | variable value | (rose violet buttercup)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10080 | |
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10081 +---------------------+
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10082 | directions to |
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10083 | property list | [not described here]
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10084 | |
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10085 +---------------------+
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10086 |/ \|
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10087 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10088 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10089 @sp 1
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10090 @end ifnottex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10091 @ifset print-postscript-figures
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10092 @sp 1
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10093 @tex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10094 @center @image{drawers}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10095 %%%% old method of including an image
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10096 % \input /usr/local/lib/tex/inputs/psfig.tex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10097 % \centerline{\psfig{figure=/usr/local/lib/emacs/man/drawers.eps}}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10098 % \catcode`\@=0 %
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10099 @end tex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10100 @sp 1
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10101 @end ifset
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10102 @ifclear print-postscript-figures
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10103 @iftex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10104 @sp 1
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10105 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10106 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10107 Chest of Drawers Contents of Drawers
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10108
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10109 __ o0O0o __
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10110 / \
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10111 ---------------------
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10112 | directions to | [map to]
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10113 | symbol name | bouquet
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10114 | |
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10115 +---------------------+
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10116 | directions to |
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10117 | symbol definition | [none]
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10118 | |
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10119 +---------------------+
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10120 | directions to | [map to]
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10121 | variable value | (rose violet buttercup)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10122 | |
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10123 +---------------------+
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10124 | directions to |
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10125 | property list | [not described here]
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10126 | |
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10127 +---------------------+
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10128 |/ \|
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10129 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10130 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10131 @sp 1
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10132 @end iftex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10133 @end ifclear
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10134
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10135 @node List Exercise, , Symbols as Chest, List Implementation
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10136 @section Exercise
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10137
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10138 Set @code{flowers} to @code{violet} and @code{buttercup}. Cons two
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10139 more flowers on to this list and set this new list to
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10140 @code{more-flowers}. Set the @sc{car} of @code{flowers} to a fish.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10141 What does the @code{more-flowers} list now contain?
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10142
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10143 @node Yanking, Loops & Recursion, List Implementation, Top
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10144 @comment node-name, next, previous, up
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10145 @chapter Yanking Text Back
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10146 @findex yank
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10147 @cindex Text retrieval
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10148 @cindex Retrieving text
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10149 @cindex Pasting text
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10150
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10151 Whenever you cut text out of a buffer with a `kill' command in GNU Emacs,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10152 you can bring it back with a `yank' command. The text that is cut out of
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10153 the buffer is put in the kill ring and the yank commands insert the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10154 appropriate contents of the kill ring back into a buffer (not necessarily
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10155 the original buffer).
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10156
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10157 A simple @kbd{C-y} (@code{yank}) command inserts the first item from
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10158 the kill ring into the current buffer. If the @kbd{C-y} command is
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10159 followed immediately by @kbd{M-y}, the first element is replaced by
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10160 the second element. Successive @kbd{M-y} commands replace the second
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10161 element with the third, fourth, or fifth element, and so on. When the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10162 last element in the kill ring is reached, it is replaced by the first
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10163 element and the cycle is repeated. (Thus the kill ring is called a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10164 `ring' rather than just a `list'. However, the actual data structure
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10165 that holds the text is a list.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10166 @xref{Kill Ring, , Handling the Kill Ring}, for the details of how the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10167 list is handled as a ring.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10168
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10169 @menu
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10170 * Kill Ring Overview::
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10171 * kill-ring-yank-pointer:: The kill ring is a list.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10172 * yank nthcdr Exercises:: The @code{kill-ring-yank-pointer} variable.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10173 @end menu
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10174
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10175 @node Kill Ring Overview, kill-ring-yank-pointer, Yanking, Yanking
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10176 @comment node-name, next, previous, up
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10177 @section Kill Ring Overview
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10178 @cindex Kill ring overview
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10179
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10180 The kill ring is a list of textual strings. This is what it looks like:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10181
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10182 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10183 ("some text" "a different piece of text" "yet more text")
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10184 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10185
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10186 If this were the contents of my kill ring and I pressed @kbd{C-y}, the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10187 string of characters saying @samp{some text} would be inserted in this
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10188 buffer where my cursor is located.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10189
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10190 The @code{yank} command is also used for duplicating text by copying it.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10191 The copied text is not cut from the buffer, but a copy of it is put on the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10192 kill ring and is inserted by yanking it back.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10193
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10194 Three functions are used for bringing text back from the kill ring:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10195 @code{yank}, which is usually bound to @kbd{C-y}; @code{yank-pop},
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10196 which is usually bound to @kbd{M-y}; and @code{rotate-yank-pointer},
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10197 which is used by the two other functions.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10198
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10199 These functions refer to the kill ring through a variable called the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10200 @code{kill-ring-yank-pointer}. Indeed, the insertion code for both the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10201 @code{yank} and @code{yank-pop} functions is:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10202
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10203 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10204 (insert (car kill-ring-yank-pointer))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10205 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10206
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10207 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10208 (Well, no more. In GNU Emacs 22, the function has been replaced by
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10209 @code{insert-for-yank} which calls @code{insert-for-yank-1}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10210 repetitively for each @code{yank-handler} segment. In turn,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10211 @code{insert-for-yank-1} strips text properties from the inserted text
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10212 according to @code{yank-excluded-properties}. Otherwise, it is just
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10213 like @code{insert}. We will stick with plain @code{insert} since it
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10214 is easier to understand.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10215
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10216 To begin to understand how @code{yank} and @code{yank-pop} work, it is
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10217 first necessary to look at the @code{kill-ring-yank-pointer} variable.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10218
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10219 @node kill-ring-yank-pointer, yank nthcdr Exercises, Kill Ring Overview, Yanking
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10220 @comment node-name, next, previous, up
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10221 @section The @code{kill-ring-yank-pointer} Variable
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10222
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10223 @code{kill-ring-yank-pointer} is a variable, just as @code{kill-ring} is
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10224 a variable. It points to something by being bound to the value of what
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10225 it points to, like any other Lisp variable.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10226
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10227 @need 1000
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10228 Thus, if the value of the kill ring is:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10229
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10230 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10231 ("some text" "a different piece of text" "yet more text")
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10232 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10233
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10234 @need 1250
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10235 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10236 and the @code{kill-ring-yank-pointer} points to the second clause, the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10237 value of @code{kill-ring-yank-pointer} is:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10238
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10239 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10240 ("a different piece of text" "yet more text")
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10241 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10242
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10243 As explained in the previous chapter (@pxref{List Implementation}), the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10244 computer does not keep two different copies of the text being pointed to
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10245 by both the @code{kill-ring} and the @code{kill-ring-yank-pointer}. The
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10246 words ``a different piece of text'' and ``yet more text'' are not
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10247 duplicated. Instead, the two Lisp variables point to the same pieces of
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10248 text. Here is a diagram:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10249
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10250 @c cons-cell-diagram #5
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10251 @ifnottex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10252 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10253 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10254 kill-ring kill-ring-yank-pointer
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10255 | |
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10256 | ___ ___ | ___ ___ ___ ___
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10257 ---> | | | --> | | | | | |
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10258 |___|___|----> |___|___|--> |___|___|--> nil
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10259 | | |
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10260 | | |
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10261 | | --> "yet more text"
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10262 | |
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10263 | --> "a different piece of text"
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10264 |
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10265 --> "some text"
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10266 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10267 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10268 @sp 1
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10269 @end ifnottex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10270 @ifset print-postscript-figures
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10271 @sp 1
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10272 @tex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10273 @center @image{cons-5}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10274 %%%% old method of including an image
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10275 % \input /usr/local/lib/tex/inputs/psfig.tex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10276 % \centerline{\psfig{figure=/usr/local/lib/emacs/man/cons-5.eps}}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10277 % \catcode`\@=0 %
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10278 @end tex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10279 @sp 1
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10280 @end ifset
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10281 @ifclear print-postscript-figures
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10282 @iftex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10283 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10284 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10285 kill-ring kill-ring-yank-pointer
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10286 | |
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10287 | ___ ___ | ___ ___ ___ ___
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10288 ---> | | | --> | | | | | |
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10289 |___|___|----> |___|___|--> |___|___|--> nil
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10290 | | |
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10291 | | |
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10292 | | --> "yet more text"
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10293 | |
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10294 | --> "a different piece of text
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10295 |
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10296 --> "some text"
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10297 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10298 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10299 @sp 1
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10300 @end iftex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10301 @end ifclear
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10302
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10303 Both the variable @code{kill-ring} and the variable
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10304 @code{kill-ring-yank-pointer} are pointers. But the kill ring itself is
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10305 usually described as if it were actually what it is composed of. The
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10306 @code{kill-ring} is spoken of as if it were the list rather than that it
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10307 points to the list. Conversely, the @code{kill-ring-yank-pointer} is
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10308 spoken of as pointing to a list.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10309
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10310 These two ways of talking about the same thing sound confusing at first but
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10311 make sense on reflection. The kill ring is generally thought of as the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10312 complete structure of data that holds the information of what has recently
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10313 been cut out of the Emacs buffers. The @code{kill-ring-yank-pointer}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10314 on the other hand, serves to indicate---that is, to `point to'---that part
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10315 of the kill ring of which the first element (the @sc{car}) will be
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10316 inserted.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10317
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10318 @ignore
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10319 In GNU Emacs 22, the @code{kill-new} function calls
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10320
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10321 @code{(setq kill-ring-yank-pointer kill-ring)}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10322
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10323 (defun rotate-yank-pointer (arg)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10324 "Rotate the yanking point in the kill ring.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10325 With argument, rotate that many kills forward (or backward, if negative)."
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10326 (interactive "p")
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10327 (current-kill arg))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10328
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10329 (defun current-kill (n &optional do-not-move)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10330 "Rotate the yanking point by N places, and then return that kill.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10331 If N is zero, `interprogram-paste-function' is set, and calling it
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10332 returns a string, then that string is added to the front of the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10333 kill ring and returned as the latest kill.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10334 If optional arg DO-NOT-MOVE is non-nil, then don't actually move the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10335 yanking point; just return the Nth kill forward."
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10336 (let ((interprogram-paste (and (= n 0)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10337 interprogram-paste-function
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10338 (funcall interprogram-paste-function))))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10339 (if interprogram-paste
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10340 (progn
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10341 ;; Disable the interprogram cut function when we add the new
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10342 ;; text to the kill ring, so Emacs doesn't try to own the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10343 ;; selection, with identical text.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10344 (let ((interprogram-cut-function nil))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10345 (kill-new interprogram-paste))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10346 interprogram-paste)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10347 (or kill-ring (error "Kill ring is empty"))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10348 (let ((ARGth-kill-element
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10349 (nthcdr (mod (- n (length kill-ring-yank-pointer))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10350 (length kill-ring))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10351 kill-ring)))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10352 (or do-not-move
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10353 (setq kill-ring-yank-pointer ARGth-kill-element))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10354 (car ARGth-kill-element)))))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10355
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10356 @end ignore
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10357
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10358 @need 1500
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10359 @node yank nthcdr Exercises, , kill-ring-yank-pointer, Yanking
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10360 @section Exercises with @code{yank} and @code{nthcdr}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10361
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10362 @itemize @bullet
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10363 @item
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10364 Using @kbd{C-h v} (@code{describe-variable}), look at the value of
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10365 your kill ring. Add several items to your kill ring; look at its
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10366 value again. Using @kbd{M-y} (@code{yank-pop)}, move all the way
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10367 around the kill ring. How many items were in your kill ring? Find
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10368 the value of @code{kill-ring-max}. Was your kill ring full, or could
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10369 you have kept more blocks of text within it?
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10370
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10371 @item
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10372 Using @code{nthcdr} and @code{car}, construct a series of expressions
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10373 to return the first, second, third, and fourth elements of a list.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10374 @end itemize
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10375
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10376 @node Loops & Recursion, Regexp Search, Yanking, Top
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10377 @comment node-name, next, previous, up
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10378 @chapter Loops and Recursion
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10379 @cindex Loops and recursion
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10380 @cindex Recursion and loops
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10381 @cindex Repetition (loops)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10382
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10383 Emacs Lisp has two primary ways to cause an expression, or a series of
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10384 expressions, to be evaluated repeatedly: one uses a @code{while}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10385 loop, and the other uses @dfn{recursion}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10386
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10387 Repetition can be very valuable. For example, to move forward four
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10388 sentences, you need only write a program that will move forward one
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10389 sentence and then repeat the process four times. Since a computer does
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10390 not get bored or tired, such repetitive action does not have the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10391 deleterious effects that excessive or the wrong kinds of repetition can
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10392 have on humans.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10393
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10394 People mostly write Emacs Lisp functions using @code{while} loops and
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10395 their kin; but you can use recursion, which provides a very powerful
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10396 way to think about and then to solve problems@footnote{You can write
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10397 recursive functions to be frugal or wasteful of mental or computer
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10398 resources; as it happens, methods that people find easy---that are
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10399 frugal of `mental resources'---sometimes use considerable computer
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10400 resources. Emacs was designed to run on machines that we now consider
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10401 limited and its default settings are conservative. You may want to
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10402 increase the values of @code{max-specpdl-size} and
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10403 @code{max-lisp-eval-depth}. In my @file{.emacs} file, I set them to
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10404 15 and 30 times their default value.}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10405
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10406 @menu
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10407 * while:: Causing a stretch of code to repeat.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10408 * dolist dotimes::
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10409 * Recursion:: Causing a function to call itself.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10410 * Looping exercise::
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10411 @end menu
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10412
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10413 @node while, dolist dotimes, Loops & Recursion, Loops & Recursion
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10414 @comment node-name, next, previous, up
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10415 @section @code{while}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10416 @cindex Loops
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10417 @findex while
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10418
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10419 The @code{while} special form tests whether the value returned by
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10420 evaluating its first argument is true or false. This is similar to what
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10421 the Lisp interpreter does with an @code{if}; what the interpreter does
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10422 next, however, is different.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10423
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10424 In a @code{while} expression, if the value returned by evaluating the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10425 first argument is false, the Lisp interpreter skips the rest of the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10426 expression (the @dfn{body} of the expression) and does not evaluate it.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10427 However, if the value is true, the Lisp interpreter evaluates the body
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10428 of the expression and then again tests whether the first argument to
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10429 @code{while} is true or false. If the value returned by evaluating the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10430 first argument is again true, the Lisp interpreter again evaluates the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10431 body of the expression.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10432
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10433 @need 1200
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10434 The template for a @code{while} expression looks like this:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10435
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10436 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10437 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10438 (while @var{true-or-false-test}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10439 @var{body}@dots{})
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10440 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10441 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10442
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10443 @menu
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10444 * Looping with while:: Repeat so long as test returns true.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10445 * Loop Example:: A @code{while} loop that uses a list.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10446 * print-elements-of-list:: Uses @code{while}, @code{car}, @code{cdr}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10447 * Incrementing Loop:: A loop with an incrementing counter.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10448 * Incrementing Loop Details::
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10449 * Decrementing Loop:: A loop with a decrementing counter.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10450 @end menu
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10451
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10452 @node Looping with while, Loop Example, while, while
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10453 @ifnottex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10454 @unnumberedsubsec Looping with @code{while}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10455 @end ifnottex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10456
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10457 So long as the true-or-false-test of the @code{while} expression
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10458 returns a true value when it is evaluated, the body is repeatedly
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10459 evaluated. This process is called a loop since the Lisp interpreter
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10460 repeats the same thing again and again, like an airplane doing a loop.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10461 When the result of evaluating the true-or-false-test is false, the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10462 Lisp interpreter does not evaluate the rest of the @code{while}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10463 expression and `exits the loop'.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10464
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10465 Clearly, if the value returned by evaluating the first argument to
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10466 @code{while} is always true, the body following will be evaluated
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10467 again and again @dots{} and again @dots{} forever. Conversely, if the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10468 value returned is never true, the expressions in the body will never
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10469 be evaluated. The craft of writing a @code{while} loop consists of
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10470 choosing a mechanism such that the true-or-false-test returns true
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10471 just the number of times that you want the subsequent expressions to
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10472 be evaluated, and then have the test return false.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10473
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10474 The value returned by evaluating a @code{while} is the value of the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10475 true-or-false-test. An interesting consequence of this is that a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10476 @code{while} loop that evaluates without error will return @code{nil}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10477 or false regardless of whether it has looped 1 or 100 times or none at
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10478 all. A @code{while} expression that evaluates successfully never
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10479 returns a true value! What this means is that @code{while} is always
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10480 evaluated for its side effects, which is to say, the consequences of
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10481 evaluating the expressions within the body of the @code{while} loop.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10482 This makes sense. It is not the mere act of looping that is desired,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10483 but the consequences of what happens when the expressions in the loop
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10484 are repeatedly evaluated.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10485
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10486 @node Loop Example, print-elements-of-list, Looping with while, while
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10487 @comment node-name, next, previous, up
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10488 @subsection A @code{while} Loop and a List
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10489
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10490 A common way to control a @code{while} loop is to test whether a list
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10491 has any elements. If it does, the loop is repeated; but if it does not,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10492 the repetition is ended. Since this is an important technique, we will
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10493 create a short example to illustrate it.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10494
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10495 A simple way to test whether a list has elements is to evaluate the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10496 list: if it has no elements, it is an empty list and will return the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10497 empty list, @code{()}, which is a synonym for @code{nil} or false. On
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10498 the other hand, a list with elements will return those elements when it
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10499 is evaluated. Since Emacs Lisp considers as true any value that is not
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10500 @code{nil}, a list that returns elements will test true in a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10501 @code{while} loop.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10502
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10503 @need 1200
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10504 For example, you can set the variable @code{empty-list} to @code{nil} by
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10505 evaluating the following @code{setq} expression:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10506
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10507 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10508 (setq empty-list ())
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10509 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10510
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10511 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10512 After evaluating the @code{setq} expression, you can evaluate the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10513 variable @code{empty-list} in the usual way, by placing the cursor after
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10514 the symbol and typing @kbd{C-x C-e}; @code{nil} will appear in your
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10515 echo area:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10516
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10517 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10518 empty-list
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10519 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10520
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10521 On the other hand, if you set a variable to be a list with elements, the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10522 list will appear when you evaluate the variable, as you can see by
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10523 evaluating the following two expressions:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10524
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10525 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10526 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10527 (setq animals '(gazelle giraffe lion tiger))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10528
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10529 animals
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10530 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10531 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10532
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10533 Thus, to create a @code{while} loop that tests whether there are any
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10534 items in the list @code{animals}, the first part of the loop will be
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10535 written like this:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10536
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10537 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10538 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10539 (while animals
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10540 @dots{}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10541 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10542 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10543
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10544 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10545 When the @code{while} tests its first argument, the variable
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10546 @code{animals} is evaluated. It returns a list. So long as the list
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10547 has elements, the @code{while} considers the results of the test to be
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10548 true; but when the list is empty, it considers the results of the test
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10549 to be false.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10550
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10551 To prevent the @code{while} loop from running forever, some mechanism
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10552 needs to be provided to empty the list eventually. An oft-used
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10553 technique is to have one of the subsequent forms in the @code{while}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10554 expression set the value of the list to be the @sc{cdr} of the list.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10555 Each time the @code{cdr} function is evaluated, the list will be made
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10556 shorter, until eventually only the empty list will be left. At this
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10557 point, the test of the @code{while} loop will return false, and the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10558 arguments to the @code{while} will no longer be evaluated.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10559
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10560 For example, the list of animals bound to the variable @code{animals}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10561 can be set to be the @sc{cdr} of the original list with the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10562 following expression:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10563
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10564 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10565 (setq animals (cdr animals))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10566 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10567
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10568 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10569 If you have evaluated the previous expressions and then evaluate this
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10570 expression, you will see @code{(giraffe lion tiger)} appear in the echo
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10571 area. If you evaluate the expression again, @code{(lion tiger)} will
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10572 appear in the echo area. If you evaluate it again and yet again,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10573 @code{(tiger)} appears and then the empty list, shown by @code{nil}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10574
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10575 A template for a @code{while} loop that uses the @code{cdr} function
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10576 repeatedly to cause the true-or-false-test eventually to test false
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10577 looks like this:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10578
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10579 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10580 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10581 (while @var{test-whether-list-is-empty}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10582 @var{body}@dots{}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10583 @var{set-list-to-cdr-of-list})
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10584 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10585 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10586
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10587 This test and use of @code{cdr} can be put together in a function that
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10588 goes through a list and prints each element of the list on a line of its
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10589 own.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10590
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10591 @node print-elements-of-list, Incrementing Loop, Loop Example, while
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10592 @subsection An Example: @code{print-elements-of-list}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10593 @findex print-elements-of-list
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10594
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10595 The @code{print-elements-of-list} function illustrates a @code{while}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10596 loop with a list.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10597
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10598 @cindex @file{*scratch*} buffer
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10599 The function requires several lines for its output. If you are
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10600 reading this in a recent instance of GNU Emacs,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10601 @c GNU Emacs 21, GNU Emacs 22, or a later version,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10602 you can evaluate the following expression inside of Info, as usual.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10603
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10604 If you are using an earlier version of Emacs, you need to copy the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10605 necessary expressions to your @file{*scratch*} buffer and evaluate
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10606 them there. This is because the echo area had only one line in the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10607 earlier versions.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10608
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10609 You can copy the expressions by marking the beginning of the region
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10610 with @kbd{C-@key{SPC}} (@code{set-mark-command}), moving the cursor to
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10611 the end of the region and then copying the region using @kbd{M-w}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10612 (@code{kill-ring-save}, which calls @code{copy-region-as-kill} and
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10613 then provides visual feedback). In the @file{*scratch*}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10614 buffer, you can yank the expressions back by typing @kbd{C-y}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10615 (@code{yank}).
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10616
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10617 After you have copied the expressions to the @file{*scratch*} buffer,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10618 evaluate each expression in turn. Be sure to evaluate the last
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10619 expression, @code{(print-elements-of-list animals)}, by typing
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10620 @kbd{C-u C-x C-e}, that is, by giving an argument to
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10621 @code{eval-last-sexp}. This will cause the result of the evaluation
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10622 to be printed in the @file{*scratch*} buffer instead of being printed
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10623 in the echo area. (Otherwise you will see something like this in your
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10624 echo area: @code{^Jgazelle^J^Jgiraffe^J^Jlion^J^Jtiger^Jnil}, in which
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10625 each @samp{^J} stands for a `newline'.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10626
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10627 @need 1500
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10628 In a recent instance of GNU Emacs, you can evaluate these expressions
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10629 directly in the Info buffer, and the echo area will grow to show the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10630 results.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10631
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10632 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10633 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10634 (setq animals '(gazelle giraffe lion tiger))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10635
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10636 (defun print-elements-of-list (list)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10637 "Print each element of LIST on a line of its own."
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10638 (while list
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10639 (print (car list))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10640 (setq list (cdr list))))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10641
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10642 (print-elements-of-list animals)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10643 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10644 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10645
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10646 @need 1200
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10647 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10648 When you evaluate the three expressions in sequence, you will see
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10649 this:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10650
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10651 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10652 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10653 gazelle
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10654
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10655 giraffe
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10656
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10657 lion
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10658
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10659 tiger
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10660 nil
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10661 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10662 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10663
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10664 Each element of the list is printed on a line of its own (that is what
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10665 the function @code{print} does) and then the value returned by the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10666 function is printed. Since the last expression in the function is the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10667 @code{while} loop, and since @code{while} loops always return
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10668 @code{nil}, a @code{nil} is printed after the last element of the list.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10669
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10670 @node Incrementing Loop, Incrementing Loop Details, print-elements-of-list, while
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10671 @comment node-name, next, previous, up
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10672 @subsection A Loop with an Incrementing Counter
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10673
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10674 A loop is not useful unless it stops when it ought. Besides
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10675 controlling a loop with a list, a common way of stopping a loop is to
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10676 write the first argument as a test that returns false when the correct
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10677 number of repetitions are complete. This means that the loop must
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10678 have a counter---an expression that counts how many times the loop
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10679 repeats itself.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10680
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10681 @node Incrementing Loop Details, Decrementing Loop, Incrementing Loop, while
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10682 @ifnottex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10683 @unnumberedsubsec Details of an Incrementing Loop
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10684 @end ifnottex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10685
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10686 The test for a loop with an incrementing counter can be an expression
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10687 such as @code{(< count desired-number)} which returns @code{t} for
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10688 true if the value of @code{count} is less than the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10689 @code{desired-number} of repetitions and @code{nil} for false if the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10690 value of @code{count} is equal to or is greater than the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10691 @code{desired-number}. The expression that increments the count can
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10692 be a simple @code{setq} such as @code{(setq count (1+ count))}, where
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10693 @code{1+} is a built-in function in Emacs Lisp that adds 1 to its
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10694 argument. (The expression @w{@code{(1+ count)}} has the same result
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10695 as @w{@code{(+ count 1)}}, but is easier for a human to read.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10696
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10697 @need 1250
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10698 The template for a @code{while} loop controlled by an incrementing
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10699 counter looks like this:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10700
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10701 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10702 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10703 @var{set-count-to-initial-value}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10704 (while (< count desired-number) ; @r{true-or-false-test}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10705 @var{body}@dots{}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10706 (setq count (1+ count))) ; @r{incrementer}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10707 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10708 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10709
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10710 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10711 Note that you need to set the initial value of @code{count}; usually it
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10712 is set to 1.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10713
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10714 @menu
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10715 * Incrementing Example:: Counting pebbles in a triangle.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10716 * Inc Example parts:: The parts of the function definition.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10717 * Inc Example altogether:: Putting the function definition together.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10718 @end menu
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10719
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10720 @node Incrementing Example, Inc Example parts, Incrementing Loop Details, Incrementing Loop Details
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10721 @unnumberedsubsubsec Example with incrementing counter
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10722
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10723 Suppose you are playing on the beach and decide to make a triangle of
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10724 pebbles, putting one pebble in the first row, two in the second row,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10725 three in the third row and so on, like this:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10726
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10727 @sp 1
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10728 @c pebble diagram
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10729 @ifnottex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10730 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10731 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10732 *
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10733 * *
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10734 * * *
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10735 * * * *
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10736 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10737 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10738 @end ifnottex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10739 @iftex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10740 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10741 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10742 @bullet{}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10743 @bullet{} @bullet{}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10744 @bullet{} @bullet{} @bullet{}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10745 @bullet{} @bullet{} @bullet{} @bullet{}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10746 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10747 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10748 @end iftex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10749 @sp 1
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10750
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10751 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10752 (About 2500 years ago, Pythagoras and others developed the beginnings of
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10753 number theory by considering questions such as this.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10754
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10755 Suppose you want to know how many pebbles you will need to make a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10756 triangle with 7 rows?
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10757
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10758 Clearly, what you need to do is add up the numbers from 1 to 7. There
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10759 are two ways to do this; start with the smallest number, one, and add up
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10760 the list in sequence, 1, 2, 3, 4 and so on; or start with the largest
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10761 number and add the list going down: 7, 6, 5, 4 and so on. Because both
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10762 mechanisms illustrate common ways of writing @code{while} loops, we will
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10763 create two examples, one counting up and the other counting down. In
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10764 this first example, we will start with 1 and add 2, 3, 4 and so on.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10765
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10766 If you are just adding up a short list of numbers, the easiest way to do
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10767 it is to add up all the numbers at once. However, if you do not know
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10768 ahead of time how many numbers your list will have, or if you want to be
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10769 prepared for a very long list, then you need to design your addition so
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10770 that what you do is repeat a simple process many times instead of doing
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10771 a more complex process once.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10772
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10773 For example, instead of adding up all the pebbles all at once, what you
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10774 can do is add the number of pebbles in the first row, 1, to the number
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10775 in the second row, 2, and then add the total of those two rows to the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10776 third row, 3. Then you can add the number in the fourth row, 4, to the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10777 total of the first three rows; and so on.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10778
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10779 The critical characteristic of the process is that each repetitive
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10780 action is simple. In this case, at each step we add only two numbers,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10781 the number of pebbles in the row and the total already found. This
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10782 process of adding two numbers is repeated again and again until the last
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10783 row has been added to the total of all the preceding rows. In a more
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10784 complex loop the repetitive action might not be so simple, but it will
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10785 be simpler than doing everything all at once.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10786
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10787 @node Inc Example parts, Inc Example altogether, Incrementing Example, Incrementing Loop Details
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10788 @unnumberedsubsubsec The parts of the function definition
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10789
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10790 The preceding analysis gives us the bones of our function definition:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10791 first, we will need a variable that we can call @code{total} that will
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10792 be the total number of pebbles. This will be the value returned by
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10793 the function.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10794
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10795 Second, we know that the function will require an argument: this
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10796 argument will be the total number of rows in the triangle. It can be
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10797 called @code{number-of-rows}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10798
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10799 Finally, we need a variable to use as a counter. We could call this
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10800 variable @code{counter}, but a better name is @code{row-number}. That
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10801 is because what the counter does in this function is count rows, and a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10802 program should be written to be as understandable as possible.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10803
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10804 When the Lisp interpreter first starts evaluating the expressions in the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10805 function, the value of @code{total} should be set to zero, since we have
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10806 not added anything to it. Then the function should add the number of
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10807 pebbles in the first row to the total, and then add the number of
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10808 pebbles in the second to the total, and then add the number of
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10809 pebbles in the third row to the total, and so on, until there are no
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10810 more rows left to add.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10811
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10812 Both @code{total} and @code{row-number} are used only inside the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10813 function, so they can be declared as local variables with @code{let}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10814 and given initial values. Clearly, the initial value for @code{total}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10815 should be 0. The initial value of @code{row-number} should be 1,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10816 since we start with the first row. This means that the @code{let}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10817 statement will look like this:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10818
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10819 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10820 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10821 (let ((total 0)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10822 (row-number 1))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10823 @var{body}@dots{})
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10824 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10825 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10826
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10827 After the internal variables are declared and bound to their initial
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10828 values, we can begin the @code{while} loop. The expression that serves
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10829 as the test should return a value of @code{t} for true so long as the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10830 @code{row-number} is less than or equal to the @code{number-of-rows}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10831 (If the expression tests true only so long as the row number is less
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10832 than the number of rows in the triangle, the last row will never be
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10833 added to the total; hence the row number has to be either less than or
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10834 equal to the number of rows.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10835
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10836 @need 1500
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10837 @findex <= @r{(less than or equal)}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10838 Lisp provides the @code{<=} function that returns true if the value of
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10839 its first argument is less than or equal to the value of its second
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10840 argument and false otherwise. So the expression that the @code{while}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10841 will evaluate as its test should look like this:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10842
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10843 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10844 (<= row-number number-of-rows)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10845 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10846
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10847 The total number of pebbles can be found by repeatedly adding the number
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10848 of pebbles in a row to the total already found. Since the number of
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10849 pebbles in the row is equal to the row number, the total can be found by
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10850 adding the row number to the total. (Clearly, in a more complex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10851 situation, the number of pebbles in the row might be related to the row
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10852 number in a more complicated way; if this were the case, the row number
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10853 would be replaced by the appropriate expression.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10854
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10855 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10856 (setq total (+ total row-number))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10857 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10858
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10859 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10860 What this does is set the new value of @code{total} to be equal to the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10861 sum of adding the number of pebbles in the row to the previous total.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10862
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10863 After setting the value of @code{total}, the conditions need to be
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10864 established for the next repetition of the loop, if there is one. This
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10865 is done by incrementing the value of the @code{row-number} variable,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10866 which serves as a counter. After the @code{row-number} variable has
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10867 been incremented, the true-or-false-test at the beginning of the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10868 @code{while} loop tests whether its value is still less than or equal to
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10869 the value of the @code{number-of-rows} and if it is, adds the new value
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10870 of the @code{row-number} variable to the @code{total} of the previous
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10871 repetition of the loop.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10872
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10873 @need 1200
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10874 The built-in Emacs Lisp function @code{1+} adds 1 to a number, so the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10875 @code{row-number} variable can be incremented with this expression:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10876
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10877 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10878 (setq row-number (1+ row-number))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10879 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10880
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10881 @node Inc Example altogether, , Inc Example parts, Incrementing Loop Details
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10882 @unnumberedsubsubsec Putting the function definition together
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10883
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10884 We have created the parts for the function definition; now we need to
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10885 put them together.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10886
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10887 @need 800
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10888 First, the contents of the @code{while} expression:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10889
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10890 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10891 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10892 (while (<= row-number number-of-rows) ; @r{true-or-false-test}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10893 (setq total (+ total row-number))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10894 (setq row-number (1+ row-number))) ; @r{incrementer}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10895 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10896 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10897
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10898 Along with the @code{let} expression varlist, this very nearly
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10899 completes the body of the function definition. However, it requires
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10900 one final element, the need for which is somewhat subtle.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10901
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10902 The final touch is to place the variable @code{total} on a line by
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10903 itself after the @code{while} expression. Otherwise, the value returned
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10904 by the whole function is the value of the last expression that is
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10905 evaluated in the body of the @code{let}, and this is the value
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10906 returned by the @code{while}, which is always @code{nil}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10907
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10908 This may not be evident at first sight. It almost looks as if the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10909 incrementing expression is the last expression of the whole function.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10910 But that expression is part of the body of the @code{while}; it is the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10911 last element of the list that starts with the symbol @code{while}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10912 Moreover, the whole of the @code{while} loop is a list within the body
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10913 of the @code{let}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10914
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10915 @need 1250
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10916 In outline, the function will look like this:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10917
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10918 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10919 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10920 (defun @var{name-of-function} (@var{argument-list})
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10921 "@var{documentation}@dots{}"
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10922 (let (@var{varlist})
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10923 (while (@var{true-or-false-test})
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10924 @var{body-of-while}@dots{} )
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10925 @dots{} )) ; @r{Need final expression here.}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10926 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10927 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10928
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10929 The result of evaluating the @code{let} is what is going to be returned
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10930 by the @code{defun} since the @code{let} is not embedded within any
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10931 containing list, except for the @code{defun} as a whole. However, if
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10932 the @code{while} is the last element of the @code{let} expression, the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10933 function will always return @code{nil}. This is not what we want!
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10934 Instead, what we want is the value of the variable @code{total}. This
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10935 is returned by simply placing the symbol as the last element of the list
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10936 starting with @code{let}. It gets evaluated after the preceding
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10937 elements of the list are evaluated, which means it gets evaluated after
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10938 it has been assigned the correct value for the total.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10939
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10940 It may be easier to see this by printing the list starting with
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10941 @code{let} all on one line. This format makes it evident that the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10942 @var{varlist} and @code{while} expressions are the second and third
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10943 elements of the list starting with @code{let}, and the @code{total} is
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10944 the last element:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10945
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10946 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10947 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10948 (let (@var{varlist}) (while (@var{true-or-false-test}) @var{body-of-while}@dots{} ) total)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10949 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10950 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10951
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10952 @need 1200
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10953 Putting everything together, the @code{triangle} function definition
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10954 looks like this:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10955
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10956 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10957 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10958 (defun triangle (number-of-rows) ; @r{Version with}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10959 ; @r{ incrementing counter.}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10960 "Add up the number of pebbles in a triangle.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10961 The first row has one pebble, the second row two pebbles,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10962 the third row three pebbles, and so on.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10963 The argument is NUMBER-OF-ROWS."
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10964 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10965 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10966 (let ((total 0)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10967 (row-number 1))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10968 (while (<= row-number number-of-rows)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10969 (setq total (+ total row-number))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10970 (setq row-number (1+ row-number)))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10971 total))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10972 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10973 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10974
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10975 @need 1200
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10976 After you have installed @code{triangle} by evaluating the function, you
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10977 can try it out. Here are two examples:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10978
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10979 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10980 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10981 (triangle 4)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10982
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10983 (triangle 7)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10984 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10985 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10986
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10987 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10988 The sum of the first four numbers is 10 and the sum of the first seven
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10989 numbers is 28.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10990
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10991 @node Decrementing Loop, , Incrementing Loop Details, while
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10992 @comment node-name, next, previous, up
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10993 @subsection Loop with a Decrementing Counter
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10994
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10995 Another common way to write a @code{while} loop is to write the test
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10996 so that it determines whether a counter is greater than zero. So long
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10997 as the counter is greater than zero, the loop is repeated. But when
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10998 the counter is equal to or less than zero, the loop is stopped. For
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10999 this to work, the counter has to start out greater than zero and then
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11000 be made smaller and smaller by a form that is evaluated
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11001 repeatedly.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11002
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11003 The test will be an expression such as @code{(> counter 0)} which
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11004 returns @code{t} for true if the value of @code{counter} is greater
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11005 than zero, and @code{nil} for false if the value of @code{counter} is
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11006 equal to or less than zero. The expression that makes the number
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11007 smaller and smaller can be a simple @code{setq} such as @code{(setq
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11008 counter (1- counter))}, where @code{1-} is a built-in function in
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11009 Emacs Lisp that subtracts 1 from its argument.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11010
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11011 @need 1250
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11012 The template for a decrementing @code{while} loop looks like this:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11013
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11014 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11015 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11016 (while (> counter 0) ; @r{true-or-false-test}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11017 @var{body}@dots{}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11018 (setq counter (1- counter))) ; @r{decrementer}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11019 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11020 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11021
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11022 @menu
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11023 * Decrementing Example:: More pebbles on the beach.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11024 * Dec Example parts:: The parts of the function definition.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11025 * Dec Example altogether:: Putting the function definition together.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11026 @end menu
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11027
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11028 @node Decrementing Example, Dec Example parts, Decrementing Loop, Decrementing Loop
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11029 @unnumberedsubsubsec Example with decrementing counter
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11030
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11031 To illustrate a loop with a decrementing counter, we will rewrite the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11032 @code{triangle} function so the counter decreases to zero.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11033
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11034 This is the reverse of the earlier version of the function. In this
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11035 case, to find out how many pebbles are needed to make a triangle with
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11036 3 rows, add the number of pebbles in the third row, 3, to the number
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11037 in the preceding row, 2, and then add the total of those two rows to
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11038 the row that precedes them, which is 1.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11039
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11040 Likewise, to find the number of pebbles in a triangle with 7 rows, add
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11041 the number of pebbles in the seventh row, 7, to the number in the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11042 preceding row, which is 6, and then add the total of those two rows to
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11043 the row that precedes them, which is 5, and so on. As in the previous
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11044 example, each addition only involves adding two numbers, the total of
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11045 the rows already added up and the number of pebbles in the row that is
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11046 being added to the total. This process of adding two numbers is
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11047 repeated again and again until there are no more pebbles to add.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11048
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11049 We know how many pebbles to start with: the number of pebbles in the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11050 last row is equal to the number of rows. If the triangle has seven
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11051 rows, the number of pebbles in the last row is 7. Likewise, we know how
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11052 many pebbles are in the preceding row: it is one less than the number in
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11053 the row.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11054
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11055 @node Dec Example parts, Dec Example altogether, Decrementing Example, Decrementing Loop
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11056 @unnumberedsubsubsec The parts of the function definition
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11057
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11058 We start with three variables: the total number of rows in the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11059 triangle; the number of pebbles in a row; and the total number of
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11060 pebbles, which is what we want to calculate. These variables can be
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11061 named @code{number-of-rows}, @code{number-of-pebbles-in-row}, and
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11062 @code{total}, respectively.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11063
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11064 Both @code{total} and @code{number-of-pebbles-in-row} are used only
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11065 inside the function and are declared with @code{let}. The initial
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11066 value of @code{total} should, of course, be zero. However, the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11067 initial value of @code{number-of-pebbles-in-row} should be equal to
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11068 the number of rows in the triangle, since the addition will start with
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11069 the longest row.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11070
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11071 @need 1250
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11072 This means that the beginning of the @code{let} expression will look
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11073 like this:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11074
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11075 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11076 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11077 (let ((total 0)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11078 (number-of-pebbles-in-row number-of-rows))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11079 @var{body}@dots{})
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11080 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11081 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11082
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11083 The total number of pebbles can be found by repeatedly adding the number
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11084 of pebbles in a row to the total already found, that is, by repeatedly
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11085 evaluating the following expression:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11086
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11087 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11088 (setq total (+ total number-of-pebbles-in-row))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11089 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11090
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11091 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11092 After the @code{number-of-pebbles-in-row} is added to the @code{total},
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11093 the @code{number-of-pebbles-in-row} should be decremented by one, since
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11094 the next time the loop repeats, the preceding row will be
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11095 added to the total.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11096
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11097 The number of pebbles in a preceding row is one less than the number of
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11098 pebbles in a row, so the built-in Emacs Lisp function @code{1-} can be
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11099 used to compute the number of pebbles in the preceding row. This can be
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11100 done with the following expression:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11101
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11102 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11103 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11104 (setq number-of-pebbles-in-row
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11105 (1- number-of-pebbles-in-row))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11106 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11107 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11108
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11109 Finally, we know that the @code{while} loop should stop making repeated
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11110 additions when there are no pebbles in a row. So the test for
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11111 the @code{while} loop is simply:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11112
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11113 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11114 (while (> number-of-pebbles-in-row 0)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11115 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11116
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11117 @node Dec Example altogether, , Dec Example parts, Decrementing Loop
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11118 @unnumberedsubsubsec Putting the function definition together
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11119
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11120 We can put these expressions together to create a function definition
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11121 that works. However, on examination, we find that one of the local
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11122 variables is unneeded!
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11123
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11124 @need 1250
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11125 The function definition looks like this:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11126
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11127 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11128 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11129 ;;; @r{First subtractive version.}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11130 (defun triangle (number-of-rows)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11131 "Add up the number of pebbles in a triangle."
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11132 (let ((total 0)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11133 (number-of-pebbles-in-row number-of-rows))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11134 (while (> number-of-pebbles-in-row 0)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11135 (setq total (+ total number-of-pebbles-in-row))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11136 (setq number-of-pebbles-in-row
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11137 (1- number-of-pebbles-in-row)))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11138 total))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11139 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11140 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11141
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11142 As written, this function works.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11143
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11144 However, we do not need @code{number-of-pebbles-in-row}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11145
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11146 @cindex Argument as local variable
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11147 When the @code{triangle} function is evaluated, the symbol
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11148 @code{number-of-rows} will be bound to a number, giving it an initial
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11149 value. That number can be changed in the body of the function as if
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11150 it were a local variable, without any fear that such a change will
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11151 effect the value of the variable outside of the function. This is a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11152 very useful characteristic of Lisp; it means that the variable
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11153 @code{number-of-rows} can be used anywhere in the function where
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11154 @code{number-of-pebbles-in-row} is used.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11155
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11156 @need 800
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11157 Here is a second version of the function written a bit more cleanly:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11158
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11159 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11160 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11161 (defun triangle (number) ; @r{Second version.}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11162 "Return sum of numbers 1 through NUMBER inclusive."
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11163 (let ((total 0))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11164 (while (> number 0)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11165 (setq total (+ total number))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11166 (setq number (1- number)))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11167 total))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11168 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11169 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11170
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11171 In brief, a properly written @code{while} loop will consist of three parts:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11172
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11173 @enumerate
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11174 @item
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11175 A test that will return false after the loop has repeated itself the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11176 correct number of times.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11177
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11178 @item
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11179 An expression the evaluation of which will return the value desired
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11180 after being repeatedly evaluated.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11181
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11182 @item
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11183 An expression to change the value passed to the true-or-false-test so
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11184 that the test returns false after the loop has repeated itself the right
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11185 number of times.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11186 @end enumerate
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11187
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11188 @node dolist dotimes, Recursion, while, Loops & Recursion
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11189 @comment node-name, next, previous, up
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11190 @section Save your time: @code{dolist} and @code{dotimes}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11191
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11192 In addition to @code{while}, both @code{dolist} and @code{dotimes}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11193 provide for looping. Sometimes these are quicker to write than the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11194 equivalent @code{while} loop. Both are Lisp macros. (@xref{Macros, ,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11195 Macros, elisp, The GNU Emacs Lisp Reference Manual}. )
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11196
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11197 @code{dolist} works like a @code{while} loop that `@sc{cdr}s down a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11198 list': @code{dolist} automatically shortens the list each time it
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11199 loops---takes the @sc{cdr} of the list---and binds the @sc{car} of
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11200 each shorter version of the list to the first of its arguments.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11201
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11202 @code{dotimes} loops a specific number of times: you specify the number.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11203
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11204 @menu
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11205 * dolist::
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11206 * dotimes::
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11207 @end menu
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11208
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11209 @node dolist, dotimes, dolist dotimes, dolist dotimes
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11210 @unnumberedsubsubsec The @code{dolist} Macro
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11211 @findex dolist
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11212
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11213 Suppose, for example, you want to reverse a list, so that
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11214 ``first'' ``second'' ``third'' becomes ``third'' ``second'' ``first''.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11215
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11216 @need 1250
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11217 In practice, you would use the @code{reverse} function, like this:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11218
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11219 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11220 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11221 (setq animals '(gazelle giraffe lion tiger))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11222
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11223 (reverse animals)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11224 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11225 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11226
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11227 @need 800
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11228 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11229 Here is how you could reverse the list using a @code{while} loop:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11230
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11231 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11232 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11233 (setq animals '(gazelle giraffe lion tiger))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11234
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11235 (defun reverse-list-with-while (list)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11236 "Using while, reverse the order of LIST."
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11237 (let (value) ; make sure list starts empty
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11238 (while list
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11239 (setq value (cons (car list) value))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11240 (setq list (cdr list)))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11241 value))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11242
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11243 (reverse-list-with-while animals)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11244 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11245 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11246
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11247 @need 800
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11248 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11249 And here is how you could use the @code{dolist} macro:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11250
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11251 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11252 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11253 (setq animals '(gazelle giraffe lion tiger))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11254
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11255 (defun reverse-list-with-dolist (list)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11256 "Using dolist, reverse the order of LIST."
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11257 (let (value) ; make sure list starts empty
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11258 (dolist (element list value)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11259 (setq value (cons element value)))))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11260
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11261 (reverse-list-with-dolist animals)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11262 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11263 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11264
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11265 @need 1250
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11266 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11267 In Info, you can place your cursor after the closing parenthesis of
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11268 each expression and type @kbd{C-x C-e}; in each case, you should see
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11269
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11270 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11271 (tiger lion giraffe gazelle)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11272 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11273
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11274 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11275 in the echo area.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11276
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11277 For this example, the existing @code{reverse} function is obviously best.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11278 The @code{while} loop is just like our first example (@pxref{Loop
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11279 Example, , A @code{while} Loop and a List}). The @code{while} first
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11280 checks whether the list has elements; if so, it constructs a new list
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11281 by adding the first element of the list to the existing list (which in
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11282 the first iteration of the loop is @code{nil}). Since the second
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11283 element is prepended in front of the first element, and the third
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11284 element is prepended in front of the second element, the list is reversed.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11285
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11286 In the expression using a @code{while} loop,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11287 the @w{@code{(setq list (cdr list))}}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11288 expression shortens the list, so the @code{while} loop eventually
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11289 stops. In addition, it provides the @code{cons} expression with a new
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11290 first element by creating a new and shorter list at each repetition of
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11291 the loop.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11292
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11293 The @code{dolist} expression does very much the same as the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11294 @code{while} expression, except that the @code{dolist} macro does some
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11295 of the work you have to do when writing a @code{while} expression.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11296
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11297 Like a @code{while} loop, a @code{dolist} loops. What is different is
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11298 that it automatically shortens the list each time it loops --- it
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11299 `@sc{cdr}s down the list' on its own --- and it automatically binds
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11300 the @sc{car} of each shorter version of the list to the first of its
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11301 arguments.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11302
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11303 In the example, the @sc{car} of each shorter version of the list is
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11304 referred to using the symbol @samp{element}, the list itself is called
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11305 @samp{list}, and the value returned is called @samp{value}. The
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11306 remainder of the @code{dolist} expression is the body.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11307
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11308 The @code{dolist} expression binds the @sc{car} of each shorter
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11309 version of the list to @code{element} and then evaluates the body of
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11310 the expression; and repeats the loop. The result is returned in
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11311 @code{value}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11312
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11313 @node dotimes, , dolist, dolist dotimes
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11314 @unnumberedsubsubsec The @code{dotimes} Macro
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11315 @findex dotimes
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11316
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11317 The @code{dotimes} macro is similar to @code{dolist}, except that it
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11318 loops a specific number of times.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11319
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11320 The first argument to @code{dotimes} is assigned the numbers 0, 1, 2
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11321 and so forth each time around the loop, and the value of the third
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11322 argument is returned. You need to provide the value of the second
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11323 argument, which is how many times the macro loops.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11324
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11325 @need 1250
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11326 For example, the following binds the numbers from 0 up to, but not
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11327 including, the number 3 to the first argument, @var{number}, and then
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11328 constructs a list of the three numbers. (The first number is 0, the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11329 second number is 1, and the third number is 2; this makes a total of
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11330 three numbers in all, starting with zero as the first number.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11331
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11332 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11333 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11334 (let (value) ; otherwise a value is a void variable
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11335 (dotimes (number 3 value)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11336 (setq value (cons number value))))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11337
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11338 @result{} (2 1 0)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11339 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11340 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11341
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11342 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11343 @code{dotimes} returns @code{value}, so the way to use
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11344 @code{dotimes} is to operate on some expression @var{number} number of
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11345 times and then return the result, either as a list or an atom.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11346
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11347 @need 1250
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11348 Here is an example of a @code{defun} that uses @code{dotimes} to add
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11349 up the number of pebbles in a triangle.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11350
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11351 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11352 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11353 (defun triangle-using-dotimes (number-of-rows)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11354 "Using dotimes, add up the number of pebbles in a triangle."
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11355 (let ((total 0)) ; otherwise a total is a void variable
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11356 (dotimes (number number-of-rows total)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11357 (setq total (+ total (1+ number))))))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11358
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11359 (triangle-using-dotimes 4)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11360 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11361 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11362
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11363 @node Recursion, Looping exercise, dolist dotimes, Loops & Recursion
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11364 @comment node-name, next, previous, up
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11365 @section Recursion
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11366 @cindex Recursion
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11367
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11368 A recursive function contains code that tells the Lisp interpreter to
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11369 call a program that runs exactly like itself, but with slightly
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11370 different arguments. The code runs exactly the same because it has
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11371 the same name. However, even though the program has the same name, it
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11372 is not the same entity. It is different. In the jargon, it is a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11373 different `instance'.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11374
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11375 Eventually, if the program is written correctly, the `slightly
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11376 different arguments' will become sufficiently different from the first
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11377 arguments that the final instance will stop.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11378
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11379 @menu
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11380 * Building Robots:: Same model, different serial number ...
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11381 * Recursive Definition Parts:: Walk until you stop ...
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11382 * Recursion with list:: Using a list as the test whether to recurse.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11383 * Recursive triangle function::
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11384 * Recursion with cond::
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11385 * Recursive Patterns:: Often used templates.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11386 * No Deferment:: Don't store up work ...
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11387 * No deferment solution::
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11388 @end menu
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11389
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11390 @node Building Robots, Recursive Definition Parts, Recursion, Recursion
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11391 @comment node-name, next, previous, up
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11392 @subsection Building Robots: Extending the Metaphor
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11393 @cindex Building robots
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11394 @cindex Robots, building
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11395
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11396 It is sometimes helpful to think of a running program as a robot that
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11397 does a job. In doing its job, a recursive function calls on a second
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11398 robot to help it. The second robot is identical to the first in every
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11399 way, except that the second robot helps the first and has been
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11400 passed different arguments than the first.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11401
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11402 In a recursive function, the second robot may call a third; and the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11403 third may call a fourth, and so on. Each of these is a different
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11404 entity; but all are clones.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11405
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11406 Since each robot has slightly different instructions---the arguments
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11407 will differ from one robot to the next---the last robot should know
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11408 when to stop.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11409
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11410 Let's expand on the metaphor in which a computer program is a robot.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11411
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11412 A function definition provides the blueprints for a robot. When you
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11413 install a function definition, that is, when you evaluate a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11414 @code{defun} special form, you install the necessary equipment to
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11415 build robots. It is as if you were in a factory, setting up an
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11416 assembly line. Robots with the same name are built according to the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11417 same blueprints. So they have, as it were, the same `model number',
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11418 but a different `serial number'.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11419
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11420 We often say that a recursive function `calls itself'. What we mean
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11421 is that the instructions in a recursive function cause the Lisp
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11422 interpreter to run a different function that has the same name and
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11423 does the same job as the first, but with different arguments.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11424
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11425 It is important that the arguments differ from one instance to the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11426 next; otherwise, the process will never stop.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11427
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11428 @node Recursive Definition Parts, Recursion with list, Building Robots, Recursion
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11429 @comment node-name, next, previous, up
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11430 @subsection The Parts of a Recursive Definition
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11431 @cindex Parts of a Recursive Definition
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11432 @cindex Recursive Definition Parts
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11433
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11434 A recursive function typically contains a conditional expression which
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11435 has three parts:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11436
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11437 @enumerate
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11438 @item
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11439 A true-or-false-test that determines whether the function is called
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11440 again, here called the @dfn{do-again-test}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11441
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11442 @item
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11443 The name of the function. When this name is called, a new instance of
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11444 the function---a new robot, as it were---is created and told what to do.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11445
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11446 @item
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11447 An expression that returns a different value each time the function is
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11448 called, here called the @dfn{next-step-expression}. Consequently, the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11449 argument (or arguments) passed to the new instance of the function
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11450 will be different from that passed to the previous instance. This
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11451 causes the conditional expression, the @dfn{do-again-test}, to test
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11452 false after the correct number of repetitions.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11453 @end enumerate
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11454
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11455 Recursive functions can be much simpler than any other kind of
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11456 function. Indeed, when people first start to use them, they often look
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11457 so mysteriously simple as to be incomprehensible. Like riding a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11458 bicycle, reading a recursive function definition takes a certain knack
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11459 which is hard at first but then seems simple.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11460
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11461 @need 1200
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11462 There are several different common recursive patterns. A very simple
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11463 pattern looks like this:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11464
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11465 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11466 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11467 (defun @var{name-of-recursive-function} (@var{argument-list})
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11468 "@var{documentation}@dots{}"
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11469 (if @var{do-again-test}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11470 @var{body}@dots{}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11471 (@var{name-of-recursive-function}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11472 @var{next-step-expression})))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11473 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11474 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11475
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11476 Each time a recursive function is evaluated, a new instance of it is
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11477 created and told what to do. The arguments tell the instance what to do.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11478
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11479 An argument is bound to the value of the next-step-expression. Each
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11480 instance runs with a different value of the next-step-expression.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11481
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11482 The value in the next-step-expression is used in the do-again-test.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11483
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11484 The value returned by the next-step-expression is passed to the new
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11485 instance of the function, which evaluates it (or some
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11486 transmogrification of it) to determine whether to continue or stop.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11487 The next-step-expression is designed so that the do-again-test returns
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11488 false when the function should no longer be repeated.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11489
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11490 The do-again-test is sometimes called the @dfn{stop condition},
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11491 since it stops the repetitions when it tests false.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11492
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11493 @node Recursion with list, Recursive triangle function, Recursive Definition Parts, Recursion
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11494 @comment node-name, next, previous, up
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11495 @subsection Recursion with a List
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11496
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11497 The example of a @code{while} loop that printed the elements of a list
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11498 of numbers can be written recursively. Here is the code, including
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11499 an expression to set the value of the variable @code{animals} to a list.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11500
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11501 If you are using GNU Emacs 20 or before, this example must be copied
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11502 to the @file{*scratch*} buffer and each expression must be evaluated
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11503 there. Use @kbd{C-u C-x C-e} to evaluate the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11504 @code{(print-elements-recursively animals)} expression so that the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11505 results are printed in the buffer; otherwise the Lisp interpreter will
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11506 try to squeeze the results into the one line of the echo area.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11507
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11508 Also, place your cursor immediately after the last closing parenthesis
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11509 of the @code{print-elements-recursively} function, before the comment.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11510 Otherwise, the Lisp interpreter will try to evaluate the comment.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11511
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11512 If you are using a more recent version of Emacs, you can evaluate this
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11513 expression directly in Info.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11514
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11515 @findex print-elements-recursively
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11516 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11517 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11518 (setq animals '(gazelle giraffe lion tiger))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11519
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11520 (defun print-elements-recursively (list)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11521 "Print each element of LIST on a line of its own.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11522 Uses recursion."
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11523 (when list ; @r{do-again-test}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11524 (print (car list)) ; @r{body}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11525 (print-elements-recursively ; @r{recursive call}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11526 (cdr list)))) ; @r{next-step-expression}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11527
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11528 (print-elements-recursively animals)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11529 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11530 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11531
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11532 The @code{print-elements-recursively} function first tests whether
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11533 there is any content in the list; if there is, the function prints the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11534 first element of the list, the @sc{car} of the list. Then the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11535 function `invokes itself', but gives itself as its argument, not the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11536 whole list, but the second and subsequent elements of the list, the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11537 @sc{cdr} of the list.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11538
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11539 Put another way, if the list is not empty, the function invokes
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11540 another instance of code that is similar to the initial code, but is a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11541 different thread of execution, with different arguments than the first
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11542 instance.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11543
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11544 Put in yet another way, if the list is not empty, the first robot
98770
c9c8b8c7805c Sean Sieger <sean.sieger at gmail.com> (tiny change)
Glenn Morris <rgm@gnu.org>
parents: 98525
diff changeset
11545 assembles a second robot and tells it what to do; the second robot is
83955
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11546 a different individual from the first, but is the same model.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11547
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11548 When the second evaluation occurs, the @code{when} expression is
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11549 evaluated and if true, prints the first element of the list it
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11550 receives as its argument (which is the second element of the original
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11551 list). Then the function `calls itself' with the @sc{cdr} of the list
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11552 it is invoked with, which (the second time around) is the @sc{cdr} of
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11553 the @sc{cdr} of the original list.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11554
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11555 Note that although we say that the function `calls itself', what we
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11556 mean is that the Lisp interpreter assembles and instructs a new
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11557 instance of the program. The new instance is a clone of the first,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11558 but is a separate individual.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11559
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11560 Each time the function `invokes itself', it invokes itself on a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11561 shorter version of the original list. It creates a new instance that
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11562 works on a shorter list.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11563
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11564 Eventually, the function invokes itself on an empty list. It creates
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11565 a new instance whose argument is @code{nil}. The conditional expression
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11566 tests the value of @code{list}. Since the value of @code{list} is
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11567 @code{nil}, the @code{when} expression tests false so the then-part is
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11568 not evaluated. The function as a whole then returns @code{nil}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11569
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11570 @need 1200
98525
b6395ec3de45 formatting fixes for new printed edition
Karl Berry <karl@gnu.org>
parents: 94896
diff changeset
11571 When you evaluate the expression @code{(print-elements-recursively
b6395ec3de45 formatting fixes for new printed edition
Karl Berry <karl@gnu.org>
parents: 94896
diff changeset
11572 animals)} in the @file{*scratch*} buffer, you see this result:
83955
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11573
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11574 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11575 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11576 gazelle
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11577
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11578 giraffe
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11579
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11580 lion
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11581
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11582 tiger
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11583 nil
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11584 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11585 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11586
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11587 @need 2000
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11588 @node Recursive triangle function, Recursion with cond, Recursion with list, Recursion
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11589 @comment node-name, next, previous, up
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11590 @subsection Recursion in Place of a Counter
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11591 @findex triangle-recursively
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11592
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11593 @need 1200
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11594 The @code{triangle} function described in a previous section can also
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11595 be written recursively. It looks like this:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11596
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11597 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11598 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11599 (defun triangle-recursively (number)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11600 "Return the sum of the numbers 1 through NUMBER inclusive.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11601 Uses recursion."
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11602 (if (= number 1) ; @r{do-again-test}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11603 1 ; @r{then-part}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11604 (+ number ; @r{else-part}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11605 (triangle-recursively ; @r{recursive call}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11606 (1- number))))) ; @r{next-step-expression}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11607
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11608 (triangle-recursively 7)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11609 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11610 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11611
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11612 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11613 You can install this function by evaluating it and then try it by
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11614 evaluating @code{(triangle-recursively 7)}. (Remember to put your
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11615 cursor immediately after the last parenthesis of the function
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11616 definition, before the comment.) The function evaluates to 28.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11617
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11618 To understand how this function works, let's consider what happens in the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11619 various cases when the function is passed 1, 2, 3, or 4 as the value of
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11620 its argument.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11621
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11622 @menu
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11623 * Recursive Example arg of 1 or 2::
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11624 * Recursive Example arg of 3 or 4::
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11625 @end menu
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11626
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11627 @node Recursive Example arg of 1 or 2, Recursive Example arg of 3 or 4, Recursive triangle function, Recursive triangle function
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11628 @ifnottex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11629 @unnumberedsubsubsec An argument of 1 or 2
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11630 @end ifnottex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11631
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11632 First, what happens if the value of the argument is 1?
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11633
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11634 The function has an @code{if} expression after the documentation
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11635 string. It tests whether the value of @code{number} is equal to 1; if
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11636 so, Emacs evaluates the then-part of the @code{if} expression, which
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11637 returns the number 1 as the value of the function. (A triangle with
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11638 one row has one pebble in it.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11639
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11640 Suppose, however, that the value of the argument is 2. In this case,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11641 Emacs evaluates the else-part of the @code{if} expression.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11642
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11643 @need 1200
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11644 The else-part consists of an addition, the recursive call to
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11645 @code{triangle-recursively} and a decrementing action; and it looks like
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11646 this:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11647
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11648 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11649 (+ number (triangle-recursively (1- number)))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11650 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11651
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11652 When Emacs evaluates this expression, the innermost expression is
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11653 evaluated first; then the other parts in sequence. Here are the steps
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11654 in detail:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11655
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11656 @table @i
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11657 @item Step 1 @w{ } Evaluate the innermost expression.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11658
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11659 The innermost expression is @code{(1- number)} so Emacs decrements the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11660 value of @code{number} from 2 to 1.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11661
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11662 @item Step 2 @w{ } Evaluate the @code{triangle-recursively} function.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11663
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11664 The Lisp interpreter creates an individual instance of
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11665 @code{triangle-recursively}. It does not matter that this function is
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11666 contained within itself. Emacs passes the result Step 1 as the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11667 argument used by this instance of the @code{triangle-recursively}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11668 function
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11669
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11670 In this case, Emacs evaluates @code{triangle-recursively} with an
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11671 argument of 1. This means that this evaluation of
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11672 @code{triangle-recursively} returns 1.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11673
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11674 @item Step 3 @w{ } Evaluate the value of @code{number}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11675
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11676 The variable @code{number} is the second element of the list that
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11677 starts with @code{+}; its value is 2.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11678
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11679 @item Step 4 @w{ } Evaluate the @code{+} expression.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11680
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11681 The @code{+} expression receives two arguments, the first
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11682 from the evaluation of @code{number} (Step 3) and the second from the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11683 evaluation of @code{triangle-recursively} (Step 2).
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11684
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11685 The result of the addition is the sum of 2 plus 1, and the number 3 is
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11686 returned, which is correct. A triangle with two rows has three
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11687 pebbles in it.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11688 @end table
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11689
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11690 @node Recursive Example arg of 3 or 4, , Recursive Example arg of 1 or 2, Recursive triangle function
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11691 @unnumberedsubsubsec An argument of 3 or 4
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11692
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11693 Suppose that @code{triangle-recursively} is called with an argument of
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11694 3.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11695
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11696 @table @i
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11697 @item Step 1 @w{ } Evaluate the do-again-test.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11698
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11699 The @code{if} expression is evaluated first. This is the do-again
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11700 test and returns false, so the else-part of the @code{if} expression
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11701 is evaluated. (Note that in this example, the do-again-test causes
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11702 the function to call itself when it tests false, not when it tests
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11703 true.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11704
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11705 @item Step 2 @w{ } Evaluate the innermost expression of the else-part.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11706
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11707 The innermost expression of the else-part is evaluated, which decrements
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11708 3 to 2. This is the next-step-expression.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11709
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11710 @item Step 3 @w{ } Evaluate the @code{triangle-recursively} function.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11711
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11712 The number 2 is passed to the @code{triangle-recursively} function.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11713
98525
b6395ec3de45 formatting fixes for new printed edition
Karl Berry <karl@gnu.org>
parents: 94896
diff changeset
11714 We already know what happens when Emacs evaluates @code{triangle-recursively} with
83955
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11715 an argument of 2. After going through the sequence of actions described
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11716 earlier, it returns a value of 3. So that is what will happen here.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11717
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11718 @item Step 4 @w{ } Evaluate the addition.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11719
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11720 3 will be passed as an argument to the addition and will be added to the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11721 number with which the function was called, which is 3.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11722 @end table
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11723
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11724 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11725 The value returned by the function as a whole will be 6.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11726
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11727 Now that we know what will happen when @code{triangle-recursively} is
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11728 called with an argument of 3, it is evident what will happen if it is
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11729 called with an argument of 4:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11730
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11731 @quotation
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11732 @need 800
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11733 In the recursive call, the evaluation of
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11734
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11735 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11736 (triangle-recursively (1- 4))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11737 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11738
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11739 @need 800
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11740 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11741 will return the value of evaluating
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11742
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11743 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11744 (triangle-recursively 3)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11745 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11746
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11747 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11748 which is 6 and this value will be added to 4 by the addition in the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11749 third line.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11750 @end quotation
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11751
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11752 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11753 The value returned by the function as a whole will be 10.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11754
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11755 Each time @code{triangle-recursively} is evaluated, it evaluates a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11756 version of itself---a different instance of itself---with a smaller
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11757 argument, until the argument is small enough so that it does not
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11758 evaluate itself.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11759
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11760 Note that this particular design for a recursive function
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11761 requires that operations be deferred.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11762
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11763 Before @code{(triangle-recursively 7)} can calculate its answer, it
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11764 must call @code{(triangle-recursively 6)}; and before
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11765 @code{(triangle-recursively 6)} can calculate its answer, it must call
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11766 @code{(triangle-recursively 5)}; and so on. That is to say, the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11767 calculation that @code{(triangle-recursively 7)} makes must be
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11768 deferred until @code{(triangle-recursively 6)} makes its calculation;
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11769 and @code{(triangle-recursively 6)} must defer until
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11770 @code{(triangle-recursively 5)} completes; and so on.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11771
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11772 If each of these instances of @code{triangle-recursively} are thought
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11773 of as different robots, the first robot must wait for the second to
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11774 complete its job, which must wait until the third completes, and so
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11775 on.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11776
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11777 There is a way around this kind of waiting, which we will discuss in
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11778 @ref{No Deferment, , Recursion without Deferments}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11779
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11780 @node Recursion with cond, Recursive Patterns, Recursive triangle function, Recursion
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11781 @comment node-name, next, previous, up
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11782 @subsection Recursion Example Using @code{cond}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11783 @findex cond
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11784
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11785 The version of @code{triangle-recursively} described earlier is written
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11786 with the @code{if} special form. It can also be written using another
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11787 special form called @code{cond}. The name of the special form
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11788 @code{cond} is an abbreviation of the word @samp{conditional}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11789
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11790 Although the @code{cond} special form is not used as often in the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11791 Emacs Lisp sources as @code{if}, it is used often enough to justify
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11792 explaining it.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11793
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11794 @need 800
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11795 The template for a @code{cond} expression looks like this:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11796
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11797 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11798 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11799 (cond
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11800 @var{body}@dots{})
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11801 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11802 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11803
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11804 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11805 where the @var{body} is a series of lists.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11806
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11807 @need 800
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11808 Written out more fully, the template looks like this:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11809
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11810 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11811 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11812 (cond
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11813 (@var{first-true-or-false-test} @var{first-consequent})
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11814 (@var{second-true-or-false-test} @var{second-consequent})
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11815 (@var{third-true-or-false-test} @var{third-consequent})
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11816 @dots{})
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11817 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11818 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11819
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11820 When the Lisp interpreter evaluates the @code{cond} expression, it
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11821 evaluates the first element (the @sc{car} or true-or-false-test) of
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11822 the first expression in a series of expressions within the body of the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11823 @code{cond}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11824
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11825 If the true-or-false-test returns @code{nil} the rest of that
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11826 expression, the consequent, is skipped and the true-or-false-test of the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11827 next expression is evaluated. When an expression is found whose
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11828 true-or-false-test returns a value that is not @code{nil}, the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11829 consequent of that expression is evaluated. The consequent can be one
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11830 or more expressions. If the consequent consists of more than one
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11831 expression, the expressions are evaluated in sequence and the value of
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11832 the last one is returned. If the expression does not have a consequent,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11833 the value of the true-or-false-test is returned.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11834
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11835 If none of the true-or-false-tests test true, the @code{cond} expression
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11836 returns @code{nil}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11837
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11838 @need 1250
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11839 Written using @code{cond}, the @code{triangle} function looks like this:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11840
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11841 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11842 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11843 (defun triangle-using-cond (number)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11844 (cond ((<= number 0) 0)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11845 ((= number 1) 1)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11846 ((> number 1)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11847 (+ number (triangle-using-cond (1- number))))))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11848 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11849 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11850
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11851 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11852 In this example, the @code{cond} returns 0 if the number is less than or
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11853 equal to 0, it returns 1 if the number is 1 and it evaluates @code{(+
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11854 number (triangle-using-cond (1- number)))} if the number is greater than
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11855 1.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11856
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11857 @node Recursive Patterns, No Deferment, Recursion with cond, Recursion
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11858 @comment node-name, next, previous, up
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11859 @subsection Recursive Patterns
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11860 @cindex Recursive Patterns
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11861
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11862 Here are three common recursive patterns. Each involves a list.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11863 Recursion does not need to involve lists, but Lisp is designed for lists
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11864 and this provides a sense of its primal capabilities.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11865
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11866 @menu
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11867 * Every::
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11868 * Accumulate::
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11869 * Keep::
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11870 @end menu
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11871
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11872 @node Every, Accumulate, Recursive Patterns, Recursive Patterns
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11873 @comment node-name, next, previous, up
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11874 @unnumberedsubsubsec Recursive Pattern: @emph{every}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11875 @cindex Every, type of recursive pattern
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11876 @cindex Recursive pattern: every
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11877
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11878 In the @code{every} recursive pattern, an action is performed on every
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11879 element of a list.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11880
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11881 @need 1500
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11882 The basic pattern is:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11883
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11884 @itemize @bullet
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11885 @item
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11886 If a list be empty, return @code{nil}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11887 @item
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11888 Else, act on the beginning of the list (the @sc{car} of the list)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11889 @itemize @minus
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11890 @item
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11891 through a recursive call by the function on the rest (the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11892 @sc{cdr}) of the list,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11893 @item
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11894 and, optionally, combine the acted-on element, using @code{cons},
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11895 with the results of acting on the rest.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11896 @end itemize
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11897 @end itemize
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11898
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11899 @need 1500
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11900 Here is example:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11901
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11902 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11903 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11904 (defun square-each (numbers-list)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11905 "Square each of a NUMBERS LIST, recursively."
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11906 (if (not numbers-list) ; do-again-test
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11907 nil
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11908 (cons
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11909 (* (car numbers-list) (car numbers-list))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11910 (square-each (cdr numbers-list))))) ; next-step-expression
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11911 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11912
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11913 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11914 (square-each '(1 2 3))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11915 @result{} (1 4 9)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11916 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11917 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11918
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11919 @need 1200
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11920 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11921 If @code{numbers-list} is empty, do nothing. But if it has content,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11922 construct a list combining the square of the first number in the list
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11923 with the result of the recursive call.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11924
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11925 (The example follows the pattern exactly: @code{nil} is returned if
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11926 the numbers' list is empty. In practice, you would write the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11927 conditional so it carries out the action when the numbers' list is not
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11928 empty.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11929
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11930 The @code{print-elements-recursively} function (@pxref{Recursion with
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11931 list, , Recursion with a List}) is another example of an @code{every}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11932 pattern, except in this case, rather than bring the results together
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11933 using @code{cons}, we print each element of output.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11934
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11935 @need 1250
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11936 The @code{print-elements-recursively} function looks like this:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11937
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11938 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11939 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11940 (setq animals '(gazelle giraffe lion tiger))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11941 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11942
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11943 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11944 (defun print-elements-recursively (list)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11945 "Print each element of LIST on a line of its own.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11946 Uses recursion."
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11947 (when list ; @r{do-again-test}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11948 (print (car list)) ; @r{body}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11949 (print-elements-recursively ; @r{recursive call}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11950 (cdr list)))) ; @r{next-step-expression}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11951
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11952 (print-elements-recursively animals)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11953 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11954 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11955
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11956 @need 1500
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11957 The pattern for @code{print-elements-recursively} is:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11958
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11959 @itemize @bullet
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11960 @item
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11961 When the list is empty, do nothing.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11962 @item
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11963 But when the list has at least one element,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11964 @itemize @minus
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11965 @item
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11966 act on the beginning of the list (the @sc{car} of the list),
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11967 @item
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11968 and make a recursive call on the rest (the @sc{cdr}) of the list.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11969 @end itemize
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11970 @end itemize
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11971
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11972 @node Accumulate, Keep, Every, Recursive Patterns
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11973 @comment node-name, next, previous, up
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11974 @unnumberedsubsubsec Recursive Pattern: @emph{accumulate}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11975 @cindex Accumulate, type of recursive pattern
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11976 @cindex Recursive pattern: accumulate
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11977
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11978 Another recursive pattern is called the @code{accumulate} pattern. In
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11979 the @code{accumulate} recursive pattern, an action is performed on
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11980 every element of a list and the result of that action is accumulated
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11981 with the results of performing the action on the other elements.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11982
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11983 This is very like the `every' pattern using @code{cons}, except that
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11984 @code{cons} is not used, but some other combiner.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11985
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11986 @need 1500
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11987 The pattern is:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11988
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11989 @itemize @bullet
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11990 @item
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11991 If a list be empty, return zero or some other constant.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11992 @item
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11993 Else, act on the beginning of the list (the @sc{car} of the list),
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11994 @itemize @minus
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11995 @item
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11996 and combine that acted-on element, using @code{+} or
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11997 some other combining function, with
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11998 @item
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11999 a recursive call by the function on the rest (the @sc{cdr}) of the list.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12000 @end itemize
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12001 @end itemize
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12002
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12003 @need 1500
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12004 Here is an example:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12005
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12006 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12007 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12008 (defun add-elements (numbers-list)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12009 "Add the elements of NUMBERS-LIST together."
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12010 (if (not numbers-list)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12011 0
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12012 (+ (car numbers-list) (add-elements (cdr numbers-list)))))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12013 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12014
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12015 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12016 (add-elements '(1 2 3 4))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12017 @result{} 10
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12018 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12019 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12020
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12021 @xref{Files List, , Making a List of Files}, for an example of the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12022 accumulate pattern.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12023
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12024 @node Keep, , Accumulate, Recursive Patterns
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12025 @comment node-name, next, previous, up
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12026 @unnumberedsubsubsec Recursive Pattern: @emph{keep}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12027 @cindex Keep, type of recursive pattern
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12028 @cindex Recursive pattern: keep
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12029
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12030 A third recursive pattern is called the @code{keep} pattern.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12031 In the @code{keep} recursive pattern, each element of a list is tested;
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12032 the element is acted on and the results are kept only if the element
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12033 meets a criterion.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12034
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12035 Again, this is very like the `every' pattern, except the element is
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12036 skipped unless it meets a criterion.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12037
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12038 @need 1500
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12039 The pattern has three parts:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12040
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12041 @itemize @bullet
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12042 @item
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12043 If a list be empty, return @code{nil}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12044 @item
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12045 Else, if the beginning of the list (the @sc{car} of the list) passes
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12046 a test
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12047 @itemize @minus
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12048 @item
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12049 act on that element and combine it, using @code{cons} with
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12050 @item
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12051 a recursive call by the function on the rest (the @sc{cdr}) of the list.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12052 @end itemize
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12053 @item
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12054 Otherwise, if the beginning of the list (the @sc{car} of the list) fails
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12055 the test
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12056 @itemize @minus
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12057 @item
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12058 skip on that element,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12059 @item
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12060 and, recursively call the function on the rest (the @sc{cdr}) of the list.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12061 @end itemize
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12062 @end itemize
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12063
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12064 @need 1500
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12065 Here is an example that uses @code{cond}:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12066
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12067 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12068 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12069 (defun keep-three-letter-words (word-list)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12070 "Keep three letter words in WORD-LIST."
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12071 (cond
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12072 ;; First do-again-test: stop-condition
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12073 ((not word-list) nil)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12074
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12075 ;; Second do-again-test: when to act
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12076 ((eq 3 (length (symbol-name (car word-list))))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12077 ;; combine acted-on element with recursive call on shorter list
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12078 (cons (car word-list) (keep-three-letter-words (cdr word-list))))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12079
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12080 ;; Third do-again-test: when to skip element;
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12081 ;; recursively call shorter list with next-step expression
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12082 (t (keep-three-letter-words (cdr word-list)))))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12083 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12084
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12085 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12086 (keep-three-letter-words '(one two three four five six))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12087 @result{} (one two six)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12088 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12089 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12090
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12091 It goes without saying that you need not use @code{nil} as the test for
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12092 when to stop; and you can, of course, combine these patterns.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12093
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12094 @node No Deferment, No deferment solution, Recursive Patterns, Recursion
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12095 @subsection Recursion without Deferments
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12096 @cindex Deferment in recursion
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12097 @cindex Recursion without Deferments
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12098
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12099 Let's consider again what happens with the @code{triangle-recursively}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12100 function. We will find that the intermediate calculations are
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12101 deferred until all can be done.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12102
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12103 @need 800
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12104 Here is the function definition:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12105
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12106 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12107 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12108 (defun triangle-recursively (number)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12109 "Return the sum of the numbers 1 through NUMBER inclusive.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12110 Uses recursion."
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12111 (if (= number 1) ; @r{do-again-test}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12112 1 ; @r{then-part}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12113 (+ number ; @r{else-part}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12114 (triangle-recursively ; @r{recursive call}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12115 (1- number))))) ; @r{next-step-expression}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12116 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12117 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12118
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12119 What happens when we call this function with a argument of 7?
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12120
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12121 The first instance of the @code{triangle-recursively} function adds
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12122 the number 7 to the value returned by a second instance of
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12123 @code{triangle-recursively}, an instance that has been passed an
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12124 argument of 6. That is to say, the first calculation is:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12125
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12126 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12127 (+ 7 (triangle-recursively 6))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12128 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12129
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12130 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12131 The first instance of @code{triangle-recursively}---you may want to
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12132 think of it as a little robot---cannot complete its job. It must hand
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12133 off the calculation for @code{(triangle-recursively 6)} to a second
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12134 instance of the program, to a second robot. This second individual is
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12135 completely different from the first one; it is, in the jargon, a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12136 `different instantiation'. Or, put another way, it is a different
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12137 robot. It is the same model as the first; it calculates triangle
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12138 numbers recursively; but it has a different serial number.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12139
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12140 And what does @code{(triangle-recursively 6)} return? It returns the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12141 number 6 added to the value returned by evaluating
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12142 @code{triangle-recursively} with an argument of 5. Using the robot
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12143 metaphor, it asks yet another robot to help it.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12144
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12145 @need 800
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12146 Now the total is:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12147
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12148 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12149 (+ 7 6 (triangle-recursively 5))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12150 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12151
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12152 @need 800
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12153 And what happens next?
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12154
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12155 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12156 (+ 7 6 5 (triangle-recursively 4))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12157 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12158
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12159 Each time @code{triangle-recursively} is called, except for the last
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12160 time, it creates another instance of the program---another robot---and
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12161 asks it to make a calculation.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12162
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12163 @need 800
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12164 Eventually, the full addition is set up and performed:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12165
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12166 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12167 (+ 7 6 5 4 3 2 1)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12168 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12169
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12170 This design for the function defers the calculation of the first step
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12171 until the second can be done, and defers that until the third can be
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12172 done, and so on. Each deferment means the computer must remember what
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12173 is being waited on. This is not a problem when there are only a few
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12174 steps, as in this example. But it can be a problem when there are
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12175 more steps.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12176
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12177 @node No deferment solution, , No Deferment, Recursion
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12178 @subsection No Deferment Solution
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12179 @cindex No deferment solution
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12180 @cindex Defermentless solution
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12181 @cindex Solution without deferment
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12182
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12183 The solution to the problem of deferred operations is to write in a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12184 manner that does not defer operations@footnote{The phrase @dfn{tail
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12185 recursive} is used to describe such a process, one that uses
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12186 `constant space'.}. This requires
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12187 writing to a different pattern, often one that involves writing two
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12188 function definitions, an `initialization' function and a `helper'
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12189 function.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12190
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12191 The `initialization' function sets up the job; the `helper' function
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12192 does the work.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12193
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12194 @need 1200
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12195 Here are the two function definitions for adding up numbers. They are
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12196 so simple, I find them hard to understand.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12197
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12198 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12199 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12200 (defun triangle-initialization (number)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12201 "Return the sum of the numbers 1 through NUMBER inclusive.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12202 This is the `initialization' component of a two function
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12203 duo that uses recursion."
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12204 (triangle-recursive-helper 0 0 number))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12205 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12206 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12207
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12208 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12209 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12210 (defun triangle-recursive-helper (sum counter number)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12211 "Return SUM, using COUNTER, through NUMBER inclusive.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12212 This is the `helper' component of a two function duo
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12213 that uses recursion."
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12214 (if (> counter number)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12215 sum
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12216 (triangle-recursive-helper (+ sum counter) ; @r{sum}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12217 (1+ counter) ; @r{counter}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12218 number))) ; @r{number}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12219 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12220 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12221
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12222 @need 1250
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12223 Install both function definitions by evaluating them, then call
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12224 @code{triangle-initialization} with 2 rows:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12225
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12226 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12227 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12228 (triangle-initialization 2)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12229 @result{} 3
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12230 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12231 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12232
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12233 The `initialization' function calls the first instance of the `helper'
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12234 function with three arguments: zero, zero, and a number which is the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12235 number of rows in the triangle.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12236
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12237 The first two arguments passed to the `helper' function are
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12238 initialization values. These values are changed when
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12239 @code{triangle-recursive-helper} invokes new instances.@footnote{The
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12240 jargon is mildly confusing: @code{triangle-recursive-helper} uses a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12241 process that is iterative in a procedure that is recursive. The
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12242 process is called iterative because the computer need only record the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12243 three values, @code{sum}, @code{counter}, and @code{number}; the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12244 procedure is recursive because the function `calls itself'. On the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12245 other hand, both the process and the procedure used by
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12246 @code{triangle-recursively} are called recursive. The word
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12247 `recursive' has different meanings in the two contexts.}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12248
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12249 Let's see what happens when we have a triangle that has one row. (This
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12250 triangle will have one pebble in it!)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12251
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12252 @need 1200
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12253 @code{triangle-initialization} will call its helper with
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12254 the arguments @w{@code{0 0 1}}. That function will run the conditional
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12255 test whether @code{(> counter number)}:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12256
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12257 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12258 (> 0 1)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12259 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12260
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12261 @need 1200
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12262 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12263 and find that the result is false, so it will invoke
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12264 the else-part of the @code{if} clause:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12265
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12266 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12267 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12268 (triangle-recursive-helper
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12269 (+ sum counter) ; @r{sum plus counter} @result{} @r{sum}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12270 (1+ counter) ; @r{increment counter} @result{} @r{counter}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12271 number) ; @r{number stays the same}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12272 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12273 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12274
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12275 @need 800
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12276 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12277 which will first compute:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12278
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12279 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12280 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12281 (triangle-recursive-helper (+ 0 0) ; @r{sum}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12282 (1+ 0) ; @r{counter}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12283 1) ; @r{number}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12284 @exdent which is:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12285
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12286 (triangle-recursive-helper 0 1 1)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12287 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12288 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12289
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12290 Again, @code{(> counter number)} will be false, so again, the Lisp
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12291 interpreter will evaluate @code{triangle-recursive-helper}, creating a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12292 new instance with new arguments.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12293
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12294 @need 800
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12295 This new instance will be;
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12296
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12297 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12298 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12299 (triangle-recursive-helper
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12300 (+ sum counter) ; @r{sum plus counter} @result{} @r{sum}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12301 (1+ counter) ; @r{increment counter} @result{} @r{counter}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12302 number) ; @r{number stays the same}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12303
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12304 @exdent which is:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12305
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12306 (triangle-recursive-helper 1 2 1)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12307 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12308 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12309
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12310 In this case, the @code{(> counter number)} test will be true! So the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12311 instance will return the value of the sum, which will be 1, as
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12312 expected.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12313
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12314 Now, let's pass @code{triangle-initialization} an argument
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12315 of 2, to find out how many pebbles there are in a triangle with two rows.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12316
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12317 That function calls @code{(triangle-recursive-helper 0 0 2)}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12318
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12319 @need 800
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12320 In stages, the instances called will be:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12321
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12322 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12323 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12324 @r{sum counter number}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12325 (triangle-recursive-helper 0 1 2)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12326
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12327 (triangle-recursive-helper 1 2 2)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12328
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12329 (triangle-recursive-helper 3 3 2)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12330 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12331 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12332
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12333 When the last instance is called, the @code{(> counter number)} test
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12334 will be true, so the instance will return the value of @code{sum},
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12335 which will be 3.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12336
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12337 This kind of pattern helps when you are writing functions that can use
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12338 many resources in a computer.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12339
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12340 @need 1500
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12341 @node Looping exercise, , Recursion, Loops & Recursion
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12342 @section Looping Exercise
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12343
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12344 @itemize @bullet
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12345 @item
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12346 Write a function similar to @code{triangle} in which each row has a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12347 value which is the square of the row number. Use a @code{while} loop.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12348
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12349 @item
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12350 Write a function similar to @code{triangle} that multiplies instead of
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12351 adds the values.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12352
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12353 @item
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12354 Rewrite these two functions recursively. Rewrite these functions
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12355 using @code{cond}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12356
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12357 @c comma in printed title causes problem in Info cross reference
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12358 @item
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12359 Write a function for Texinfo mode that creates an index entry at the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12360 beginning of a paragraph for every @samp{@@dfn} within the paragraph.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12361 (In a Texinfo file, @samp{@@dfn} marks a definition. This book is
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12362 written in Texinfo.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12363
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12364 Many of the functions you will need are described in two of the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12365 previous chapters, @ref{Cutting & Storing Text, , Cutting and Storing
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12366 Text}, and @ref{Yanking, , Yanking Text Back}. If you use
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12367 @code{forward-paragraph} to put the index entry at the beginning of
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12368 the paragraph, you will have to use @w{@kbd{C-h f}}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12369 (@code{describe-function}) to find out how to make the command go
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12370 backwards.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12371
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12372 For more information, see
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12373 @ifinfo
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12374 @ref{Indicating, , Indicating Definitions, texinfo}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12375 @end ifinfo
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12376 @ifhtml
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12377 @ref{Indicating, , Indicating, texinfo, Texinfo Manual}, which goes to
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12378 a Texinfo manual in the current directory. Or, if you are on the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12379 Internet, see
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12380 @uref{http://www.gnu.org/software/texinfo/manual/texinfo/}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12381 @end ifhtml
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12382 @iftex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12383 ``Indicating Definitions, Commands, etc.'' in @cite{Texinfo, The GNU
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12384 Documentation Format}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12385 @end iftex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12386 @end itemize
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12387
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12388 @node Regexp Search, Counting Words, Loops & Recursion, Top
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12389 @comment node-name, next, previous, up
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12390 @chapter Regular Expression Searches
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12391 @cindex Searches, illustrating
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12392 @cindex Regular expression searches
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12393 @cindex Patterns, searching for
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12394 @cindex Motion by sentence and paragraph
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12395 @cindex Sentences, movement by
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12396 @cindex Paragraphs, movement by
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12397
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12398 Regular expression searches are used extensively in GNU Emacs. The
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12399 two functions, @code{forward-sentence} and @code{forward-paragraph},
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12400 illustrate these searches well. They use regular expressions to find
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12401 where to move point. The phrase `regular expression' is often written
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12402 as `regexp'.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12403
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12404 Regular expression searches are described in @ref{Regexp Search, ,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12405 Regular Expression Search, emacs, The GNU Emacs Manual}, as well as in
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12406 @ref{Regular Expressions, , , elisp, The GNU Emacs Lisp Reference
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12407 Manual}. In writing this chapter, I am presuming that you have at
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12408 least a mild acquaintance with them. The major point to remember is
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12409 that regular expressions permit you to search for patterns as well as
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12410 for literal strings of characters. For example, the code in
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12411 @code{forward-sentence} searches for the pattern of possible
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12412 characters that could mark the end of a sentence, and moves point to
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12413 that spot.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12414
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12415 Before looking at the code for the @code{forward-sentence} function, it
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12416 is worth considering what the pattern that marks the end of a sentence
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12417 must be. The pattern is discussed in the next section; following that
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12418 is a description of the regular expression search function,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12419 @code{re-search-forward}. The @code{forward-sentence} function
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12420 is described in the section following. Finally, the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12421 @code{forward-paragraph} function is described in the last section of
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12422 this chapter. @code{forward-paragraph} is a complex function that
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12423 introduces several new features.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12424
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12425 @menu
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12426 * sentence-end:: The regular expression for @code{sentence-end}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12427 * re-search-forward:: Very similar to @code{search-forward}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12428 * forward-sentence:: A straightforward example of regexp search.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12429 * forward-paragraph:: A somewhat complex example.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12430 * etags:: How to create your own @file{TAGS} table.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12431 * Regexp Review::
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12432 * re-search Exercises::
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12433 @end menu
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12434
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12435 @node sentence-end, re-search-forward, Regexp Search, Regexp Search
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12436 @comment node-name, next, previous, up
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12437 @section The Regular Expression for @code{sentence-end}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12438 @findex sentence-end
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12439
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12440 The symbol @code{sentence-end} is bound to the pattern that marks the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12441 end of a sentence. What should this regular expression be?
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12442
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12443 Clearly, a sentence may be ended by a period, a question mark, or an
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12444 exclamation mark. Indeed, in English, only clauses that end with one
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12445 of those three characters should be considered the end of a sentence.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12446 This means that the pattern should include the character set:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12447
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12448 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12449 [.?!]
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12450 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12451
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12452 However, we do not want @code{forward-sentence} merely to jump to a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12453 period, a question mark, or an exclamation mark, because such a character
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12454 might be used in the middle of a sentence. A period, for example, is
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12455 used after abbreviations. So other information is needed.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12456
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12457 According to convention, you type two spaces after every sentence, but
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12458 only one space after a period, a question mark, or an exclamation mark in
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12459 the body of a sentence. So a period, a question mark, or an exclamation
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12460 mark followed by two spaces is a good indicator of an end of sentence.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12461 However, in a file, the two spaces may instead be a tab or the end of a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12462 line. This means that the regular expression should include these three
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12463 items as alternatives.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12464
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12465 @need 800
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12466 This group of alternatives will look like this:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12467
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12468 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12469 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12470 \\($\\| \\| \\)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12471 ^ ^^
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12472 TAB SPC
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12473 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12474 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12475
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12476 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12477 Here, @samp{$} indicates the end of the line, and I have pointed out
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12478 where the tab and two spaces are inserted in the expression. Both are
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12479 inserted by putting the actual characters into the expression.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12480
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12481 Two backslashes, @samp{\\}, are required before the parentheses and
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12482 vertical bars: the first backslash quotes the following backslash in
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12483 Emacs; and the second indicates that the following character, the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12484 parenthesis or the vertical bar, is special.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12485
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12486 @need 1000
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12487 Also, a sentence may be followed by one or more carriage returns, like
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12488 this:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12489
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12490 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12491 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12492 [
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12493 ]*
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12494 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12495 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12496
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12497 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12498 Like tabs and spaces, a carriage return is inserted into a regular
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12499 expression by inserting it literally. The asterisk indicates that the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12500 @key{RET} is repeated zero or more times.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12501
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12502 But a sentence end does not consist only of a period, a question mark or
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12503 an exclamation mark followed by appropriate space: a closing quotation
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12504 mark or a closing brace of some kind may precede the space. Indeed more
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12505 than one such mark or brace may precede the space. These require a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12506 expression that looks like this:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12507
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12508 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12509 []\"')@}]*
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12510 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12511
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12512 In this expression, the first @samp{]} is the first character in the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12513 expression; the second character is @samp{"}, which is preceded by a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12514 @samp{\} to tell Emacs the @samp{"} is @emph{not} special. The last
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12515 three characters are @samp{'}, @samp{)}, and @samp{@}}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12516
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12517 All this suggests what the regular expression pattern for matching the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12518 end of a sentence should be; and, indeed, if we evaluate
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12519 @code{sentence-end} we find that it returns the following value:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12520
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12521 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12522 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12523 sentence-end
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12524 @result{} "[.?!][]\"')@}]*\\($\\| \\| \\)[
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12525 ]*"
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12526 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12527 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12528
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12529 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12530 (Well, not in GNU Emacs 22; that is because of an effort to make the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12531 process simpler and to handle more glyphs and languages. When the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12532 value of @code{sentence-end} is @code{nil}, then use the value defined
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12533 by the function @code{sentence-end}. (Here is a use of the difference
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12534 between a value and a function in Emacs Lisp.) The function returns a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12535 value constructed from the variables @code{sentence-end-base},
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12536 @code{sentence-end-double-space}, @code{sentence-end-without-period},
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12537 and @code{sentence-end-without-space}. The critical variable is
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12538 @code{sentence-end-base}; its global value is similar to the one
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12539 described above but it also contains two additional quotation marks.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12540 These have differing degrees of curliness. The
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12541 @code{sentence-end-without-period} variable, when true, tells Emacs
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12542 that a sentence may end without a period, such as text in Thai.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12543
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12544 @ignore
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12545 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12546 (Note that here the @key{TAB}, two spaces, and @key{RET} are shown
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12547 literally in the pattern.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12548
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12549 This regular expression can be deciphered as follows:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12550
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12551 @table @code
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12552 @item [.?!]
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12553 The first part of the pattern is the three characters, a period, a question
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12554 mark and an exclamation mark, within square brackets. The pattern must
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12555 begin with one or other of these characters.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12556
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12557 @item []\"')@}]*
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12558 The second part of the pattern is the group of closing braces and
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12559 quotation marks, which can appear zero or more times. These may follow
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12560 the period, question mark or exclamation mark. In a regular expression,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12561 the backslash, @samp{\}, followed by the double quotation mark,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12562 @samp{"}, indicates the class of string-quote characters. Usually, the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12563 double quotation mark is the only character in this class. The
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12564 asterisk, @samp{*}, indicates that the items in the previous group (the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12565 group surrounded by square brackets, @samp{[]}) may be repeated zero or
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12566 more times.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12567
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12568 @item \\($\\| \\| \\)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12569 The third part of the pattern is one or other of: either the end of a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12570 line, or two blank spaces, or a tab. The double back-slashes are used
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12571 to prevent Emacs from reading the parentheses and vertical bars as part
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12572 of the search pattern; the parentheses are used to mark the group and
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12573 the vertical bars are used to indicated that the patterns to either side
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12574 of them are alternatives. The dollar sign is used to indicate the end
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12575 of a line and both the two spaces and the tab are each inserted as is to
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12576 indicate what they are.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12577
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12578 @item [@key{RET}]*
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12579 Finally, the last part of the pattern indicates that the end of the line
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12580 or the whitespace following the period, question mark or exclamation
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12581 mark may, but need not, be followed by one or more carriage returns. In
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12582 the pattern, the carriage return is inserted as an actual carriage
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12583 return between square brackets but here it is shown as @key{RET}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12584 @end table
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12585 @end ignore
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12586
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12587 @node re-search-forward, forward-sentence, sentence-end, Regexp Search
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12588 @comment node-name, next, previous, up
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12589 @section The @code{re-search-forward} Function
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12590 @findex re-search-forward
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12591
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12592 The @code{re-search-forward} function is very like the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12593 @code{search-forward} function. (@xref{search-forward, , The
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12594 @code{search-forward} Function}.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12595
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12596 @code{re-search-forward} searches for a regular expression. If the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12597 search is successful, it leaves point immediately after the last
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12598 character in the target. If the search is backwards, it leaves point
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12599 just before the first character in the target. You may tell
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12600 @code{re-search-forward} to return @code{t} for true. (Moving point
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12601 is therefore a `side effect'.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12602
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12603 Like @code{search-forward}, the @code{re-search-forward} function takes
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12604 four arguments:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12605
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12606 @enumerate
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12607 @item
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12608 The first argument is the regular expression that the function searches
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12609 for. The regular expression will be a string between quotations marks.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12610
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12611 @item
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12612 The optional second argument limits how far the function will search; it is a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12613 bound, which is specified as a position in the buffer.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12614
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12615 @item
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12616 The optional third argument specifies how the function responds to
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12617 failure: @code{nil} as the third argument causes the function to
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12618 signal an error (and print a message) when the search fails; any other
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12619 value causes it to return @code{nil} if the search fails and @code{t}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12620 if the search succeeds.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12621
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12622 @item
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12623 The optional fourth argument is the repeat count. A negative repeat
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12624 count causes @code{re-search-forward} to search backwards.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12625 @end enumerate
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12626
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12627 @need 800
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12628 The template for @code{re-search-forward} looks like this:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12629
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12630 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12631 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12632 (re-search-forward "@var{regular-expression}"
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12633 @var{limit-of-search}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12634 @var{what-to-do-if-search-fails}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12635 @var{repeat-count})
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12636 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12637 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12638
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12639 The second, third, and fourth arguments are optional. However, if you
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12640 want to pass a value to either or both of the last two arguments, you
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12641 must also pass a value to all the preceding arguments. Otherwise, the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12642 Lisp interpreter will mistake which argument you are passing the value
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12643 to.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12644
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12645 @need 1200
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12646 In the @code{forward-sentence} function, the regular expression will be
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12647 the value of the variable @code{sentence-end}. In simple form, that is:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12648
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12649 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12650 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12651 "[.?!][]\"')@}]*\\($\\| \\| \\)[
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12652 ]*"
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12653 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12654 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12655
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12656 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12657 The limit of the search will be the end of the paragraph (since a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12658 sentence cannot go beyond a paragraph). If the search fails, the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12659 function will return @code{nil}; and the repeat count will be provided
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12660 by the argument to the @code{forward-sentence} function.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12661
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12662 @node forward-sentence, forward-paragraph, re-search-forward, Regexp Search
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12663 @comment node-name, next, previous, up
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12664 @section @code{forward-sentence}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12665 @findex forward-sentence
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12666
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12667 The command to move the cursor forward a sentence is a straightforward
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12668 illustration of how to use regular expression searches in Emacs Lisp.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12669 Indeed, the function looks longer and more complicated than it is; this
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12670 is because the function is designed to go backwards as well as forwards;
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12671 and, optionally, over more than one sentence. The function is usually
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12672 bound to the key command @kbd{M-e}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12673
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12674 @menu
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12675 * Complete forward-sentence::
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12676 * fwd-sentence while loops:: Two @code{while} loops.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12677 * fwd-sentence re-search:: A regular expression search.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12678 @end menu
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12679
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12680 @node Complete forward-sentence, fwd-sentence while loops, forward-sentence, forward-sentence
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12681 @ifnottex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12682 @unnumberedsubsec Complete @code{forward-sentence} function definition
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12683 @end ifnottex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12684
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12685 @need 1250
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12686 Here is the code for @code{forward-sentence}:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12687
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12688 @c in GNU Emacs 22
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12689 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12690 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12691 (defun forward-sentence (&optional arg)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12692 "Move forward to next `sentence-end'. With argument, repeat.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12693 With negative argument, move backward repeatedly to `sentence-beginning'.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12694
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12695 The variable `sentence-end' is a regular expression that matches ends of
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12696 sentences. Also, every paragraph boundary terminates sentences as well."
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12697 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12698 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12699 (interactive "p")
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12700 (or arg (setq arg 1))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12701 (let ((opoint (point))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12702 (sentence-end (sentence-end)))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12703 (while (< arg 0)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12704 (let ((pos (point))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12705 (par-beg (save-excursion (start-of-paragraph-text) (point))))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12706 (if (and (re-search-backward sentence-end par-beg t)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12707 (or (< (match-end 0) pos)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12708 (re-search-backward sentence-end par-beg t)))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12709 (goto-char (match-end 0))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12710 (goto-char par-beg)))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12711 (setq arg (1+ arg)))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12712 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12713 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12714 (while (> arg 0)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12715 (let ((par-end (save-excursion (end-of-paragraph-text) (point))))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12716 (if (re-search-forward sentence-end par-end t)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12717 (skip-chars-backward " \t\n")
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12718 (goto-char par-end)))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12719 (setq arg (1- arg)))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12720 (constrain-to-field nil opoint t)))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12721 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12722 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12723
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12724 @ignore
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12725 GNU Emacs 21
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12726 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12727 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12728 (defun forward-sentence (&optional arg)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12729 "Move forward to next sentence-end. With argument, repeat.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12730 With negative argument, move backward repeatedly to sentence-beginning.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12731 Sentence ends are identified by the value of sentence-end
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12732 treated as a regular expression. Also, every paragraph boundary
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12733 terminates sentences as well."
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12734 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12735 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12736 (interactive "p")
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12737 (or arg (setq arg 1))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12738 (while (< arg 0)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12739 (let ((par-beg
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12740 (save-excursion (start-of-paragraph-text) (point))))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12741 (if (re-search-backward
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12742 (concat sentence-end "[^ \t\n]") par-beg t)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12743 (goto-char (1- (match-end 0)))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12744 (goto-char par-beg)))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12745 (setq arg (1+ arg)))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12746 (while (> arg 0)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12747 (let ((par-end
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12748 (save-excursion (end-of-paragraph-text) (point))))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12749 (if (re-search-forward sentence-end par-end t)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12750 (skip-chars-backward " \t\n")
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12751 (goto-char par-end)))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12752 (setq arg (1- arg))))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12753 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12754 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12755 @end ignore
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12756
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12757 The function looks long at first sight and it is best to look at its
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12758 skeleton first, and then its muscle. The way to see the skeleton is to
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12759 look at the expressions that start in the left-most columns:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12760
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12761 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12762 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12763 (defun forward-sentence (&optional arg)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12764 "@var{documentation}@dots{}"
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12765 (interactive "p")
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12766 (or arg (setq arg 1))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12767 (let ((opoint (point)) (sentence-end (sentence-end)))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12768 (while (< arg 0)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12769 (let ((pos (point))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12770 (par-beg (save-excursion (start-of-paragraph-text) (point))))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12771 @var{rest-of-body-of-while-loop-when-going-backwards}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12772 (while (> arg 0)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12773 (let ((par-end (save-excursion (end-of-paragraph-text) (point))))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12774 @var{rest-of-body-of-while-loop-when-going-forwards}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12775 @var{handle-forms-and-equivalent}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12776 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12777 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12778
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12779 This looks much simpler! The function definition consists of
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12780 documentation, an @code{interactive} expression, an @code{or}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12781 expression, a @code{let} expression, and @code{while} loops.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12782
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12783 Let's look at each of these parts in turn.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12784
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12785 We note that the documentation is thorough and understandable.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12786
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12787 The function has an @code{interactive "p"} declaration. This means
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12788 that the processed prefix argument, if any, is passed to the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12789 function as its argument. (This will be a number.) If the function
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12790 is not passed an argument (it is optional) then the argument
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12791 @code{arg} will be bound to 1.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12792
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12793 When @code{forward-sentence} is called non-interactively without an
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12794 argument, @code{arg} is bound to @code{nil}. The @code{or} expression
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12795 handles this. What it does is either leave the value of @code{arg} as
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12796 it is, but only if @code{arg} is bound to a value; or it sets the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12797 value of @code{arg} to 1, in the case when @code{arg} is bound to
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12798 @code{nil}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12799
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12800 Next is a @code{let}. That specifies the values of two local
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12801 variables, @code{point} and @code{sentence-end}. The local value of
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12802 point, from before the search, is used in the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12803 @code{constrain-to-field} function which handles forms and
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12804 equivalents. The @code{sentence-end} variable is set by the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12805 @code{sentence-end} function.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12806
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12807 @node fwd-sentence while loops, fwd-sentence re-search, Complete forward-sentence, forward-sentence
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12808 @unnumberedsubsec The @code{while} loops
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12809
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12810 Two @code{while} loops follow. The first @code{while} has a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12811 true-or-false-test that tests true if the prefix argument for
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12812 @code{forward-sentence} is a negative number. This is for going
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12813 backwards. The body of this loop is similar to the body of the second
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12814 @code{while} clause, but it is not exactly the same. We will skip
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12815 this @code{while} loop and concentrate on the second @code{while}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12816 loop.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12817
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12818 @need 1500
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12819 The second @code{while} loop is for moving point forward. Its skeleton
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12820 looks like this:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12821
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12822 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12823 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12824 (while (> arg 0) ; @r{true-or-false-test}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12825 (let @var{varlist}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12826 (if (@var{true-or-false-test})
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12827 @var{then-part}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12828 @var{else-part}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12829 (setq arg (1- arg)))) ; @code{while} @r{loop decrementer}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12830 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12831 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12832
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12833 The @code{while} loop is of the decrementing kind.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12834 (@xref{Decrementing Loop, , A Loop with a Decrementing Counter}.) It
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12835 has a true-or-false-test that tests true so long as the counter (in
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12836 this case, the variable @code{arg}) is greater than zero; and it has a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12837 decrementer that subtracts 1 from the value of the counter every time
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12838 the loop repeats.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12839
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12840 If no prefix argument is given to @code{forward-sentence}, which is
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12841 the most common way the command is used, this @code{while} loop will
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12842 run once, since the value of @code{arg} will be 1.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12843
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12844 The body of the @code{while} loop consists of a @code{let} expression,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12845 which creates and binds a local variable, and has, as its body, an
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12846 @code{if} expression.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12847
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12848 @need 1250
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12849 The body of the @code{while} loop looks like this:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12850
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12851 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12852 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12853 (let ((par-end
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12854 (save-excursion (end-of-paragraph-text) (point))))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12855 (if (re-search-forward sentence-end par-end t)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12856 (skip-chars-backward " \t\n")
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12857 (goto-char par-end)))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12858 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12859 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12860
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12861 The @code{let} expression creates and binds the local variable
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12862 @code{par-end}. As we shall see, this local variable is designed to
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12863 provide a bound or limit to the regular expression search. If the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12864 search fails to find a proper sentence ending in the paragraph, it will
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12865 stop on reaching the end of the paragraph.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12866
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12867 But first, let us examine how @code{par-end} is bound to the value of
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12868 the end of the paragraph. What happens is that the @code{let} sets the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12869 value of @code{par-end} to the value returned when the Lisp interpreter
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12870 evaluates the expression
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12871
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12872 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12873 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12874 (save-excursion (end-of-paragraph-text) (point))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12875 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12876 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12877
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12878 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12879 In this expression, @code{(end-of-paragraph-text)} moves point to the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12880 end of the paragraph, @code{(point)} returns the value of point, and then
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12881 @code{save-excursion} restores point to its original position. Thus,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12882 the @code{let} binds @code{par-end} to the value returned by the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12883 @code{save-excursion} expression, which is the position of the end of
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12884 the paragraph. (The @code{end-of-paragraph-text} function uses
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12885 @code{forward-paragraph}, which we will discuss shortly.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12886
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12887 @need 1200
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12888 Emacs next evaluates the body of the @code{let}, which is an @code{if}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12889 expression that looks like this:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12890
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12891 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12892 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12893 (if (re-search-forward sentence-end par-end t) ; @r{if-part}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12894 (skip-chars-backward " \t\n") ; @r{then-part}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12895 (goto-char par-end))) ; @r{else-part}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12896 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12897 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12898
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12899 The @code{if} tests whether its first argument is true and if so,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12900 evaluates its then-part; otherwise, the Emacs Lisp interpreter
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12901 evaluates the else-part. The true-or-false-test of the @code{if}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12902 expression is the regular expression search.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12903
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12904 It may seem odd to have what looks like the `real work' of
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12905 the @code{forward-sentence} function buried here, but this is a common
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12906 way this kind of operation is carried out in Lisp.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12907
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12908 @node fwd-sentence re-search, , fwd-sentence while loops, forward-sentence
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12909 @unnumberedsubsec The regular expression search
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12910
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12911 The @code{re-search-forward} function searches for the end of the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12912 sentence, that is, for the pattern defined by the @code{sentence-end}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12913 regular expression. If the pattern is found---if the end of the sentence is
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12914 found---then the @code{re-search-forward} function does two things:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12915
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12916 @enumerate
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12917 @item
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12918 The @code{re-search-forward} function carries out a side effect, which
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12919 is to move point to the end of the occurrence found.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12920
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12921 @item
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12922 The @code{re-search-forward} function returns a value of true. This is
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12923 the value received by the @code{if}, and means that the search was
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12924 successful.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12925 @end enumerate
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12926
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12927 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12928 The side effect, the movement of point, is completed before the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12929 @code{if} function is handed the value returned by the successful
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12930 conclusion of the search.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12931
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12932 When the @code{if} function receives the value of true from a successful
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12933 call to @code{re-search-forward}, the @code{if} evaluates the then-part,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12934 which is the expression @code{(skip-chars-backward " \t\n")}. This
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12935 expression moves backwards over any blank spaces, tabs or carriage
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12936 returns until a printed character is found and then leaves point after
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12937 the character. Since point has already been moved to the end of the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12938 pattern that marks the end of the sentence, this action leaves point
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12939 right after the closing printed character of the sentence, which is
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12940 usually a period.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12941
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12942 On the other hand, if the @code{re-search-forward} function fails to
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12943 find a pattern marking the end of the sentence, the function returns
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12944 false. The false then causes the @code{if} to evaluate its third
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12945 argument, which is @code{(goto-char par-end)}: it moves point to the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12946 end of the paragraph.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12947
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12948 (And if the text is in a form or equivalent, and point may not move
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12949 fully, then the @code{constrain-to-field} function comes into play.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12950
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12951 Regular expression searches are exceptionally useful and the pattern
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12952 illustrated by @code{re-search-forward}, in which the search is the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12953 test of an @code{if} expression, is handy. You will see or write code
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12954 incorporating this pattern often.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12955
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12956 @node forward-paragraph, etags, forward-sentence, Regexp Search
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12957 @comment node-name, next, previous, up
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12958 @section @code{forward-paragraph}: a Goldmine of Functions
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12959 @findex forward-paragraph
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12960
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12961 @ignore
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12962 @c in GNU Emacs 22
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12963 (defun forward-paragraph (&optional arg)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12964 "Move forward to end of paragraph.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12965 With argument ARG, do it ARG times;
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12966 a negative argument ARG = -N means move backward N paragraphs.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12967
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12968 A line which `paragraph-start' matches either separates paragraphs
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12969 \(if `paragraph-separate' matches it also) or is the first line of a paragraph.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12970 A paragraph end is the beginning of a line which is not part of the paragraph
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12971 to which the end of the previous line belongs, or the end of the buffer.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12972 Returns the count of paragraphs left to move."
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12973 (interactive "p")
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12974 (or arg (setq arg 1))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12975 (let* ((opoint (point))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12976 (fill-prefix-regexp
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12977 (and fill-prefix (not (equal fill-prefix ""))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12978 (not paragraph-ignore-fill-prefix)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12979 (regexp-quote fill-prefix)))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12980 ;; Remove ^ from paragraph-start and paragraph-sep if they are there.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12981 ;; These regexps shouldn't be anchored, because we look for them
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12982 ;; starting at the left-margin. This allows paragraph commands to
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12983 ;; work normally with indented text.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12984 ;; This hack will not find problem cases like "whatever\\|^something".
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12985 (parstart (if (and (not (equal "" paragraph-start))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12986 (equal ?^ (aref paragraph-start 0)))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12987 (substring paragraph-start 1)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12988 paragraph-start))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12989 (parsep (if (and (not (equal "" paragraph-separate))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12990 (equal ?^ (aref paragraph-separate 0)))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12991 (substring paragraph-separate 1)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12992 paragraph-separate))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12993 (parsep
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12994 (if fill-prefix-regexp
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12995 (concat parsep "\\|"
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12996 fill-prefix-regexp "[ \t]*$")
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12997 parsep))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12998 ;; This is used for searching.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12999 (sp-parstart (concat "^[ \t]*\\(?:" parstart "\\|" parsep "\\)"))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13000 start found-start)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13001 (while (and (< arg 0) (not (bobp)))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13002 (if (and (not (looking-at parsep))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13003 (re-search-backward "^\n" (max (1- (point)) (point-min)) t)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13004 (looking-at parsep))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13005 (setq arg (1+ arg))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13006 (setq start (point))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13007 ;; Move back over paragraph-separating lines.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13008 (forward-char -1) (beginning-of-line)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13009 (while (and (not (bobp))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13010 (progn (move-to-left-margin)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13011 (looking-at parsep)))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13012 (forward-line -1))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13013 (if (bobp)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13014 nil
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13015 (setq arg (1+ arg))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13016 ;; Go to end of the previous (non-separating) line.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13017 (end-of-line)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13018 ;; Search back for line that starts or separates paragraphs.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13019 (if (if fill-prefix-regexp
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13020 ;; There is a fill prefix; it overrides parstart.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13021 (let (multiple-lines)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13022 (while (and (progn (beginning-of-line) (not (bobp)))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13023 (progn (move-to-left-margin)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13024 (not (looking-at parsep)))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13025 (looking-at fill-prefix-regexp))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13026 (unless (= (point) start)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13027 (setq multiple-lines t))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13028 (forward-line -1))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13029 (move-to-left-margin)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13030 ;; This deleted code caused a long hanging-indent line
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13031 ;; not to be filled together with the following lines.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13032 ;; ;; Don't move back over a line before the paragraph
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13033 ;; ;; which doesn't start with fill-prefix
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13034 ;; ;; unless that is the only line we've moved over.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13035 ;; (and (not (looking-at fill-prefix-regexp))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13036 ;; multiple-lines
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13037 ;; (forward-line 1))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13038 (not (bobp)))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13039 (while (and (re-search-backward sp-parstart nil 1)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13040 (setq found-start t)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13041 ;; Found a candidate, but need to check if it is a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13042 ;; REAL parstart.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13043 (progn (setq start (point))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13044 (move-to-left-margin)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13045 (not (looking-at parsep)))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13046 (not (and (looking-at parstart)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13047 (or (not use-hard-newlines)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13048 (bobp)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13049 (get-text-property
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13050 (1- start) 'hard)))))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13051 (setq found-start nil)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13052 (goto-char start))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13053 found-start)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13054 ;; Found one.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13055 (progn
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13056 ;; Move forward over paragraph separators.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13057 ;; We know this cannot reach the place we started
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13058 ;; because we know we moved back over a non-separator.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13059 (while (and (not (eobp))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13060 (progn (move-to-left-margin)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13061 (looking-at parsep)))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13062 (forward-line 1))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13063 ;; If line before paragraph is just margin, back up to there.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13064 (end-of-line 0)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13065 (if (> (current-column) (current-left-margin))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13066 (forward-char 1)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13067 (skip-chars-backward " \t")
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13068 (if (not (bolp))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13069 (forward-line 1))))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13070 ;; No starter or separator line => use buffer beg.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13071 (goto-char (point-min))))))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13072
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13073 (while (and (> arg 0) (not (eobp)))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13074 ;; Move forward over separator lines...
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13075 (while (and (not (eobp))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13076 (progn (move-to-left-margin) (not (eobp)))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13077 (looking-at parsep))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13078 (forward-line 1))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13079 (unless (eobp) (setq arg (1- arg)))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13080 ;; ... and one more line.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13081 (forward-line 1)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13082 (if fill-prefix-regexp
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13083 ;; There is a fill prefix; it overrides parstart.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13084 (while (and (not (eobp))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13085 (progn (move-to-left-margin) (not (eobp)))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13086 (not (looking-at parsep))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13087 (looking-at fill-prefix-regexp))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13088 (forward-line 1))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13089 (while (and (re-search-forward sp-parstart nil 1)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13090 (progn (setq start (match-beginning 0))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13091 (goto-char start)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13092 (not (eobp)))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13093 (progn (move-to-left-margin)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13094 (not (looking-at parsep)))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13095 (or (not (looking-at parstart))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13096 (and use-hard-newlines
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13097 (not (get-text-property (1- start) 'hard)))))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13098 (forward-char 1))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13099 (if (< (point) (point-max))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13100 (goto-char start))))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13101 (constrain-to-field nil opoint t)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13102 ;; Return the number of steps that could not be done.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13103 arg))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13104 @end ignore
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13105
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13106 The @code{forward-paragraph} function moves point forward to the end
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13107 of the paragraph. It is usually bound to @kbd{M-@}} and makes use of a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13108 number of functions that are important in themselves, including
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13109 @code{let*}, @code{match-beginning}, and @code{looking-at}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13110
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13111 The function definition for @code{forward-paragraph} is considerably
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13112 longer than the function definition for @code{forward-sentence}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13113 because it works with a paragraph, each line of which may begin with a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13114 fill prefix.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13115
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13116 A fill prefix consists of a string of characters that are repeated at
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13117 the beginning of each line. For example, in Lisp code, it is a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13118 convention to start each line of a paragraph-long comment with
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13119 @samp{;;; }. In Text mode, four blank spaces make up another common
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13120 fill prefix, creating an indented paragraph. (@xref{Fill Prefix, , ,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13121 emacs, The GNU Emacs Manual}, for more information about fill
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13122 prefixes.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13123
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13124 The existence of a fill prefix means that in addition to being able to
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13125 find the end of a paragraph whose lines begin on the left-most
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13126 column, the @code{forward-paragraph} function must be able to find the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13127 end of a paragraph when all or many of the lines in the buffer begin
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13128 with the fill prefix.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13129
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13130 Moreover, it is sometimes practical to ignore a fill prefix that
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13131 exists, especially when blank lines separate paragraphs.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13132 This is an added complication.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13133
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13134 @menu
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13135 * forward-paragraph in brief:: Key parts of the function definition.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13136 * fwd-para let:: The @code{let*} expression.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13137 * fwd-para while:: The forward motion @code{while} loop.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13138 @end menu
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13139
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13140 @node forward-paragraph in brief, fwd-para let, forward-paragraph, forward-paragraph
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13141 @ifnottex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13142 @unnumberedsubsec Shortened @code{forward-paragraph} function definition
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13143 @end ifnottex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13144
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13145 Rather than print all of the @code{forward-paragraph} function, we
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13146 will only print parts of it. Read without preparation, the function
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13147 can be daunting!
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13148
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13149 @need 800
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13150 In outline, the function looks like this:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13151
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13152 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13153 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13154 (defun forward-paragraph (&optional arg)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13155 "@var{documentation}@dots{}"
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13156 (interactive "p")
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13157 (or arg (setq arg 1))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13158 (let*
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13159 @var{varlist}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13160 (while (and (< arg 0) (not (bobp))) ; @r{backward-moving-code}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13161 @dots{}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13162 (while (and (> arg 0) (not (eobp))) ; @r{forward-moving-code}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13163 @dots{}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13164 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13165 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13166
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13167 The first parts of the function are routine: the function's argument
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13168 list consists of one optional argument. Documentation follows.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13169
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13170 The lower case @samp{p} in the @code{interactive} declaration means
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13171 that the processed prefix argument, if any, is passed to the function.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13172 This will be a number, and is the repeat count of how many paragraphs
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13173 point will move. The @code{or} expression in the next line handles
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13174 the common case when no argument is passed to the function, which occurs
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13175 if the function is called from other code rather than interactively.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13176 This case was described earlier. (@xref{forward-sentence, The
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13177 @code{forward-sentence} function}.) Now we reach the end of the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13178 familiar part of this function.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13179
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13180 @node fwd-para let, fwd-para while, forward-paragraph in brief, forward-paragraph
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13181 @unnumberedsubsec The @code{let*} expression
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13182
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13183 The next line of the @code{forward-paragraph} function begins a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13184 @code{let*} expression. This is a different than @code{let}. The
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13185 symbol is @code{let*} not @code{let}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13186
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13187 The @code{let*} special form is like @code{let} except that Emacs sets
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13188 each variable in sequence, one after another, and variables in the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13189 latter part of the varlist can make use of the values to which Emacs
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13190 set variables in the earlier part of the varlist.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13191
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13192 @ignore
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13193 ( refappend save-excursion, , code save-excursion in code append-to-buffer .)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13194 @end ignore
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13195
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13196 (@ref{append save-excursion, , @code{save-excursion} in @code{append-to-buffer}}.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13197
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13198 In the @code{let*} expression in this function, Emacs binds a total of
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13199 seven variables: @code{opoint}, @code{fill-prefix-regexp},
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13200 @code{parstart}, @code{parsep}, @code{sp-parstart}, @code{start}, and
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13201 @code{found-start}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13202
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13203 The variable @code{parsep} appears twice, first, to remove instances
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13204 of @samp{^}, and second, to handle fill prefixes.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13205
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13206 The variable @code{opoint} is just the value of @code{point}. As you
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13207 can guess, it is used in a @code{constrain-to-field} expression, just
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13208 as in @code{forward-sentence}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13209
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13210 The variable @code{fill-prefix-regexp} is set to the value returned by
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13211 evaluating the following list:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13212
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13213 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13214 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13215 (and fill-prefix
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13216 (not (equal fill-prefix ""))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13217 (not paragraph-ignore-fill-prefix)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13218 (regexp-quote fill-prefix))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13219 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13220 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13221
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13222 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13223 This is an expression whose first element is the @code{and} special form.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13224
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13225 As we learned earlier (@pxref{kill-new function, , The @code{kill-new}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13226 function}), the @code{and} special form evaluates each of its
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13227 arguments until one of the arguments returns a value of @code{nil}, in
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13228 which case the @code{and} expression returns @code{nil}; however, if
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13229 none of the arguments returns a value of @code{nil}, the value
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13230 resulting from evaluating the last argument is returned. (Since such
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13231 a value is not @code{nil}, it is considered true in Lisp.) In other
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13232 words, an @code{and} expression returns a true value only if all its
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13233 arguments are true.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13234 @findex and
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13235
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13236 In this case, the variable @code{fill-prefix-regexp} is bound to a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13237 non-@code{nil} value only if the following four expressions produce a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13238 true (i.e., a non-@code{nil}) value when they are evaluated; otherwise,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13239 @code{fill-prefix-regexp} is bound to @code{nil}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13240
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13241 @table @code
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13242 @item fill-prefix
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13243 When this variable is evaluated, the value of the fill prefix, if any,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13244 is returned. If there is no fill prefix, this variable returns
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13245 @code{nil}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13246
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13247 @item (not (equal fill-prefix "")
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13248 This expression checks whether an existing fill prefix is an empty
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13249 string, that is, a string with no characters in it. An empty string is
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13250 not a useful fill prefix.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13251
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13252 @item (not paragraph-ignore-fill-prefix)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13253 This expression returns @code{nil} if the variable
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13254 @code{paragraph-ignore-fill-prefix} has been turned on by being set to a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13255 true value such as @code{t}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13256
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13257 @item (regexp-quote fill-prefix)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13258 This is the last argument to the @code{and} special form. If all the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13259 arguments to the @code{and} are true, the value resulting from
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13260 evaluating this expression will be returned by the @code{and} expression
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13261 and bound to the variable @code{fill-prefix-regexp},
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13262 @end table
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13263
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13264 @findex regexp-quote
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13265 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13266 The result of evaluating this @code{and} expression successfully is that
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13267 @code{fill-prefix-regexp} will be bound to the value of
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13268 @code{fill-prefix} as modified by the @code{regexp-quote} function.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13269 What @code{regexp-quote} does is read a string and return a regular
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13270 expression that will exactly match the string and match nothing else.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13271 This means that @code{fill-prefix-regexp} will be set to a value that
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13272 will exactly match the fill prefix if the fill prefix exists.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13273 Otherwise, the variable will be set to @code{nil}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13274
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13275 The next two local variables in the @code{let*} expression are
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13276 designed to remove instances of @samp{^} from @code{parstart} and
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13277 @code{parsep}, the local variables which indicate the paragraph start
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13278 and the paragraph separator. The next expression sets @code{parsep}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13279 again. That is to handle fill prefixes.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13280
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13281 This is the setting that requires the definition call @code{let*}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13282 rather than @code{let}. The true-or-false-test for the @code{if}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13283 depends on whether the variable @code{fill-prefix-regexp} evaluates to
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13284 @code{nil} or some other value.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13285
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13286 If @code{fill-prefix-regexp} does not have a value, Emacs evaluates
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13287 the else-part of the @code{if} expression and binds @code{parsep} to
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13288 its local value. (@code{parsep} is a regular expression that matches
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13289 what separates paragraphs.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13290
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13291 But if @code{fill-prefix-regexp} does have a value, Emacs evaluates
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13292 the then-part of the @code{if} expression and binds @code{parsep} to a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13293 regular expression that includes the @code{fill-prefix-regexp} as part
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13294 of the pattern.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13295
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13296 Specifically, @code{parsep} is set to the original value of the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13297 paragraph separate regular expression concatenated with an alternative
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13298 expression that consists of the @code{fill-prefix-regexp} followed by
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13299 optional whitespace to the end of the line. The whitespace is defined
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13300 by @w{@code{"[ \t]*$"}}.) The @samp{\\|} defines this portion of the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13301 regexp as an alternative to @code{parsep}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13302
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13303 According to a comment in the code, the next local variable,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13304 @code{sp-parstart}, is used for searching, and then the final two,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13305 @code{start} and @code{found-start}, are set to @code{nil}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13306
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13307 Now we get into the body of the @code{let*}. The first part of the body
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13308 of the @code{let*} deals with the case when the function is given a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13309 negative argument and is therefore moving backwards. We will skip this
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13310 section.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13311
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13312 @node fwd-para while, , fwd-para let, forward-paragraph
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13313 @unnumberedsubsec The forward motion @code{while} loop
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13314
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13315 The second part of the body of the @code{let*} deals with forward
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13316 motion. It is a @code{while} loop that repeats itself so long as the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13317 value of @code{arg} is greater than zero. In the most common use of
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13318 the function, the value of the argument is 1, so the body of the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13319 @code{while} loop is evaluated exactly once, and the cursor moves
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13320 forward one paragraph.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13321
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13322 @ignore
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13323 (while (and (> arg 0) (not (eobp)))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13324
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13325 ;; Move forward over separator lines...
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13326 (while (and (not (eobp))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13327 (progn (move-to-left-margin) (not (eobp)))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13328 (looking-at parsep))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13329 (forward-line 1))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13330 (unless (eobp) (setq arg (1- arg)))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13331 ;; ... and one more line.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13332 (forward-line 1)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13333
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13334 (if fill-prefix-regexp
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13335 ;; There is a fill prefix; it overrides parstart.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13336 (while (and (not (eobp))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13337 (progn (move-to-left-margin) (not (eobp)))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13338 (not (looking-at parsep))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13339 (looking-at fill-prefix-regexp))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13340 (forward-line 1))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13341
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13342 (while (and (re-search-forward sp-parstart nil 1)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13343 (progn (setq start (match-beginning 0))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13344 (goto-char start)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13345 (not (eobp)))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13346 (progn (move-to-left-margin)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13347 (not (looking-at parsep)))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13348 (or (not (looking-at parstart))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13349 (and use-hard-newlines
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13350 (not (get-text-property (1- start) 'hard)))))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13351 (forward-char 1))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13352
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13353 (if (< (point) (point-max))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13354 (goto-char start))))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13355 @end ignore
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13356
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13357 This part handles three situations: when point is between paragraphs,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13358 when there is a fill prefix and when there is no fill prefix.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13359
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13360 @need 800
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13361 The @code{while} loop looks like this:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13362
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13363 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13364 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13365 ;; @r{going forwards and not at the end of the buffer}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13366 (while (and (> arg 0) (not (eobp)))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13367
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13368 ;; @r{between paragraphs}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13369 ;; Move forward over separator lines...
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13370 (while (and (not (eobp))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13371 (progn (move-to-left-margin) (not (eobp)))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13372 (looking-at parsep))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13373 (forward-line 1))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13374 ;; @r{This decrements the loop}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13375 (unless (eobp) (setq arg (1- arg)))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13376 ;; ... and one more line.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13377 (forward-line 1)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13378 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13379
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13380 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13381 (if fill-prefix-regexp
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13382 ;; There is a fill prefix; it overrides parstart;
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13383 ;; we go forward line by line
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13384 (while (and (not (eobp))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13385 (progn (move-to-left-margin) (not (eobp)))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13386 (not (looking-at parsep))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13387 (looking-at fill-prefix-regexp))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13388 (forward-line 1))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13389 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13390
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13391 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13392 ;; There is no fill prefix;
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13393 ;; we go forward character by character
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13394 (while (and (re-search-forward sp-parstart nil 1)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13395 (progn (setq start (match-beginning 0))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13396 (goto-char start)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13397 (not (eobp)))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13398 (progn (move-to-left-margin)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13399 (not (looking-at parsep)))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13400 (or (not (looking-at parstart))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13401 (and use-hard-newlines
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13402 (not (get-text-property (1- start) 'hard)))))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13403 (forward-char 1))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13404 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13405
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13406 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13407 ;; and if there is no fill prefix and if we are not at the end,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13408 ;; go to whatever was found in the regular expression search
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13409 ;; for sp-parstart
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13410 (if (< (point) (point-max))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13411 (goto-char start))))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13412 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13413 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13414
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13415 @findex eobp
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13416 We can see that this is a decrementing counter @code{while} loop,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13417 using the expression @code{(setq arg (1- arg))} as the decrementer.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13418 That expression is not far from the @code{while}, but is hidden in
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13419 another Lisp macro, an @code{unless} macro. Unless we are at the end
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13420 of the buffer --- that is what the @code{eobp} function determines; it
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13421 is an abbreviation of @samp{End Of Buffer P} --- we decrease the value
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13422 of @code{arg} by one.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13423
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13424 (If we are at the end of the buffer, we cannot go forward any more and
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13425 the next loop of the @code{while} expression will test false since the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13426 test is an @code{and} with @code{(not (eobp))}. The @code{not}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13427 function means exactly as you expect; it is another name for
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13428 @code{null}, a function that returns true when its argument is false.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13429
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13430 Interestingly, the loop count is not decremented until we leave the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13431 space between paragraphs, unless we come to the end of buffer or stop
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13432 seeing the local value of the paragraph separator.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13433
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13434 That second @code{while} also has a @code{(move-to-left-margin)}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13435 expression. The function is self-explanatory. It is inside a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13436 @code{progn} expression and not the last element of its body, so it is
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13437 only invoked for its side effect, which is to move point to the left
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13438 margin of the current line.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13439
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13440 @findex looking-at
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13441 The @code{looking-at} function is also self-explanatory; it returns
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13442 true if the text after point matches the regular expression given as
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13443 its argument.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13444
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13445 The rest of the body of the loop looks difficult at first, but makes
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13446 sense as you come to understand it.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13447
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13448 @need 800
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13449 First consider what happens if there is a fill prefix:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13450
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13451 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13452 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13453 (if fill-prefix-regexp
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13454 ;; There is a fill prefix; it overrides parstart;
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13455 ;; we go forward line by line
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13456 (while (and (not (eobp))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13457 (progn (move-to-left-margin) (not (eobp)))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13458 (not (looking-at parsep))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13459 (looking-at fill-prefix-regexp))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13460 (forward-line 1))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13461 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13462 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13463
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13464 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13465 This expression moves point forward line by line so long
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13466 as four conditions are true:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13467
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13468 @enumerate
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13469 @item
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13470 Point is not at the end of the buffer.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13471
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13472 @item
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13473 We can move to the left margin of the text and are
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13474 not at the end of the buffer.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13475
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13476 @item
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13477 The text following point does not separate paragraphs.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13478
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13479 @item
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13480 The pattern following point is the fill prefix regular expression.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13481 @end enumerate
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13482
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13483 The last condition may be puzzling, until you remember that point was
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13484 moved to the beginning of the line early in the @code{forward-paragraph}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13485 function. This means that if the text has a fill prefix, the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13486 @code{looking-at} function will see it.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13487
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13488 @need 1250
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13489 Consider what happens when there is no fill prefix.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13490
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13491 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13492 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13493 (while (and (re-search-forward sp-parstart nil 1)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13494 (progn (setq start (match-beginning 0))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13495 (goto-char start)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13496 (not (eobp)))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13497 (progn (move-to-left-margin)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13498 (not (looking-at parsep)))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13499 (or (not (looking-at parstart))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13500 (and use-hard-newlines
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13501 (not (get-text-property (1- start) 'hard)))))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13502 (forward-char 1))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13503 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13504 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13505
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13506 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13507 This @code{while} loop has us searching forward for
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13508 @code{sp-parstart}, which is the combination of possible whitespace
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13509 with a the local value of the start of a paragraph or of a paragraph
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13510 separator. (The latter two are within an expression starting
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13511 @code{\(?:} so that they are not referenced by the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13512 @code{match-beginning} function.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13513
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13514 @need 800
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13515 The two expressions,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13516
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13517 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13518 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13519 (setq start (match-beginning 0))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13520 (goto-char start)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13521 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13522 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13523
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13524 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13525 mean go to the start of the text matched by the regular expression
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13526 search.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13527
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13528 The @code{(match-beginning 0)} expression is new. It returns a number
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13529 specifying the location of the start of the text that was matched by
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13530 the last search.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13531
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13532 The @code{match-beginning} function is used here because of a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13533 characteristic of a forward search: a successful forward search,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13534 regardless of whether it is a plain search or a regular expression
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13535 search, moves point to the end of the text that is found. In this
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13536 case, a successful search moves point to the end of the pattern for
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13537 @code{sp-parstart}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13538
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13539 However, we want to put point at the end of the current paragraph, not
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13540 somewhere else. Indeed, since the search possibly includes the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13541 paragraph separator, point may end up at the beginning of the next one
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13542 unless we use an expression that includes @code{match-beginning}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13543
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13544 @findex match-beginning
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13545 When given an argument of 0, @code{match-beginning} returns the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13546 position that is the start of the text matched by the most recent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13547 search. In this case, the most recent search looks for
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13548 @code{sp-parstart}. The @code{(match-beginning 0)} expression returns
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13549 the beginning position of that pattern, rather than the end position
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13550 of that pattern.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13551
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13552 (Incidentally, when passed a positive number as an argument, the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13553 @code{match-beginning} function returns the location of point at that
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13554 parenthesized expression in the last search unless that parenthesized
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13555 expression begins with @code{\(?:}. I don't know why @code{\(?:}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13556 appears here since the argument is 0.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13557
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13558 @need 1250
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13559 The last expression when there is no fill prefix is
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13560
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13561 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13562 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13563 (if (< (point) (point-max))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13564 (goto-char start))))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13565 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13566 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13567
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13568 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13569 This says that if there is no fill prefix and if we are not at the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13570 end, point should move to the beginning of whatever was found by the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13571 regular expression search for @code{sp-parstart}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13572
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13573 The full definition for the @code{forward-paragraph} function not only
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13574 includes code for going forwards, but also code for going backwards.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13575
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13576 If you are reading this inside of GNU Emacs and you want to see the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13577 whole function, you can type @kbd{C-h f} (@code{describe-function})
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13578 and the name of the function. This gives you the function
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13579 documentation and the name of the library containing the function's
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13580 source. Place point over the name of the library and press the RET
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13581 key; you will be taken directly to the source. (Be sure to install
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13582 your sources! Without them, you are like a person who tries to drive
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13583 a car with his eyes shut!)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13584
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13585 @node etags, Regexp Review, forward-paragraph, Regexp Search
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13586 @section Create Your Own @file{TAGS} File
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13587 @findex etags
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13588 @cindex @file{TAGS} file, create own
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13589
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13590 Besides @kbd{C-h f} (@code{describe-function}), another way to see the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13591 source of a function is to type @kbd{M-.} (@code{find-tag}) and the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13592 name of the function when prompted for it. This is a good habit to
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13593 get into. The @kbd{M-.} (@code{find-tag}) command takes you directly
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13594 to the source for a function, variable, or node. The function depends
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13595 on tags tables to tell it where to go.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13596
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13597 If the @code{find-tag} function first asks you for the name of a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13598 @file{TAGS} table, give it the name of a @file{TAGS} file such as
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13599 @file{/usr/local/src/emacs/src/TAGS}. (The exact path to your
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13600 @file{TAGS} file depends on how your copy of Emacs was installed. I
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13601 just told you the location that provides both my C and my Emacs Lisp
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13602 sources.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13603
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13604 You can also create your own @file{TAGS} file for directories that
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13605 lack one.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13606
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13607 You often need to build and install tags tables yourself. They are
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13608 not built automatically. A tags table is called a @file{TAGS} file;
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13609 the name is in upper case letters.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13610
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13611 You can create a @file{TAGS} file by calling the @code{etags} program
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13612 that comes as a part of the Emacs distribution. Usually, @code{etags}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13613 is compiled and installed when Emacs is built. (@code{etags} is not
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13614 an Emacs Lisp function or a part of Emacs; it is a C program.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13615
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13616 @need 1250
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13617 To create a @file{TAGS} file, first switch to the directory in which
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13618 you want to create the file. In Emacs you can do this with the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13619 @kbd{M-x cd} command, or by visiting a file in the directory, or by
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13620 listing the directory with @kbd{C-x d} (@code{dired}). Then run the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13621 compile command, with @w{@code{etags *.el}} as the command to execute
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13622
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13623 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13624 M-x compile RET etags *.el RET
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13625 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13626
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13627 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13628 to create a @file{TAGS} file for Emacs Lisp.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13629
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13630 For example, if you have a large number of files in your
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13631 @file{~/emacs} directory, as I do---I have 137 @file{.el} files in it,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13632 of which I load 12---you can create a @file{TAGS} file for the Emacs
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13633 Lisp files in that directory.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13634
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13635 @need 1250
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13636 The @code{etags} program takes all the usual shell `wildcards'. For
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13637 example, if you have two directories for which you want a single
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13638 @file{TAGS} file, type @w{@code{etags *.el ../elisp/*.el}}, where
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13639 @file{../elisp/} is the second directory:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13640
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13641 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13642 M-x compile RET etags *.el ../elisp/*.el RET
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13643 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13644
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13645 @need 1250
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13646 Type
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13647
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13648 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13649 M-x compile RET etags --help RET
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13650 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13651
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13652 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13653 to see a list of the options accepted by @code{etags} as well as a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13654 list of supported languages.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13655
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13656 The @code{etags} program handles more than 20 languages, including
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13657 Emacs Lisp, Common Lisp, Scheme, C, C++, Ada, Fortran, HTML, Java,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13658 LaTeX, Pascal, Perl, Postscript, Python, TeX, Texinfo, makefiles, and
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13659 most assemblers. The program has no switches for specifying the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13660 language; it recognizes the language in an input file according to its
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13661 file name and contents.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13662
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13663 @file{etags} is very helpful when you are writing code yourself and
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13664 want to refer back to functions you have already written. Just run
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13665 @code{etags} again at intervals as you write new functions, so they
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13666 become part of the @file{TAGS} file.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13667
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13668 If you think an appropriate @file{TAGS} file already exists for what
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13669 you want, but do not know where it is, you can use the @code{locate}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13670 program to attempt to find it.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13671
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13672 Type @w{@kbd{M-x locate @key{RET} TAGS @key{RET}}} and Emacs will list
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13673 for you the full path names of all your @file{TAGS} files. On my
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13674 system, this command lists 34 @file{TAGS} files. On the other hand, a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13675 `plain vanilla' system I recently installed did not contain any
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13676 @file{TAGS} files.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13677
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13678 If the tags table you want has been created, you can use the @code{M-x
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13679 visit-tags-table} command to specify it. Otherwise, you will need to
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13680 create the tag table yourself and then use @code{M-x
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13681 visit-tags-table}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13682
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13683 @subsubheading Building Tags in the Emacs sources
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13684 @cindex Building Tags in the Emacs sources
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13685 @cindex Tags in the Emacs sources
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13686 @findex make tags
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13687
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13688 The GNU Emacs sources come with a @file{Makefile} that contains a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13689 sophisticated @code{etags} command that creates, collects, and merges
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13690 tags tables from all over the Emacs sources and puts the information
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13691 into one @file{TAGS} file in the @file{src/} directory. (The
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13692 @file{src/} directory is below the top level of your Emacs directory.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13693
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13694 @need 1250
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13695 To build this @file{TAGS} file, go to the top level of your Emacs
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13696 source directory and run the compile command @code{make tags}:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13697
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13698 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13699 M-x compile RET make tags RET
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13700 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13701
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13702 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13703 (The @code{make tags} command works well with the GNU Emacs sources,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13704 as well as with some other source packages.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13705
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13706 For more information, see @ref{Tags, , Tag Tables, emacs, The GNU Emacs
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13707 Manual}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13708
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13709 @node Regexp Review, re-search Exercises, etags, Regexp Search
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13710 @comment node-name, next, previous, up
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13711 @section Review
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13712
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13713 Here is a brief summary of some recently introduced functions.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13714
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13715 @table @code
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13716 @item while
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13717 Repeatedly evaluate the body of the expression so long as the first
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13718 element of the body tests true. Then return @code{nil}. (The
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13719 expression is evaluated only for its side effects.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13720
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13721 @need 1250
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13722 For example:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13723
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13724 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13725 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13726 (let ((foo 2))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13727 (while (> foo 0)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13728 (insert (format "foo is %d.\n" foo))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13729 (setq foo (1- foo))))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13730
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13731 @result{} foo is 2.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13732 foo is 1.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13733 nil
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13734 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13735 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13736
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13737 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13738 (The @code{insert} function inserts its arguments at point; the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13739 @code{format} function returns a string formatted from its arguments
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13740 the way @code{message} formats its arguments; @code{\n} produces a new
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13741 line.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13742
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13743 @item re-search-forward
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13744 Search for a pattern, and if the pattern is found, move point to rest
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13745 just after it.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13746
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13747 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13748 Takes four arguments, like @code{search-forward}:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13749
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13750 @enumerate
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13751 @item
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13752 A regular expression that specifies the pattern to search for.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13753 (Remember to put quotation marks around this argument!)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13754
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13755 @item
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13756 Optionally, the limit of the search.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13757
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13758 @item
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13759 Optionally, what to do if the search fails, return @code{nil} or an
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13760 error message.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13761
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13762 @item
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13763 Optionally, how many times to repeat the search; if negative, the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13764 search goes backwards.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13765 @end enumerate
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13766
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13767 @item let*
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13768 Bind some variables locally to particular values,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13769 and then evaluate the remaining arguments, returning the value of the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13770 last one. While binding the local variables, use the local values of
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13771 variables bound earlier, if any.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13772
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13773 @need 1250
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13774 For example:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13775
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13776 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13777 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13778 (let* ((foo 7)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13779 (bar (* 3 foo)))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13780 (message "`bar' is %d." bar))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13781 @result{} `bar' is 21.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13782 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13783 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13784
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13785 @item match-beginning
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13786 Return the position of the start of the text found by the last regular
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13787 expression search.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13788
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13789 @item looking-at
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13790 Return @code{t} for true if the text after point matches the argument,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13791 which should be a regular expression.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13792
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13793 @item eobp
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13794 Return @code{t} for true if point is at the end of the accessible part
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13795 of a buffer. The end of the accessible part is the end of the buffer
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13796 if the buffer is not narrowed; it is the end of the narrowed part if
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13797 the buffer is narrowed.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13798 @end table
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13799
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13800 @need 1500
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13801 @node re-search Exercises, , Regexp Review, Regexp Search
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13802 @section Exercises with @code{re-search-forward}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13803
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13804 @itemize @bullet
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13805 @item
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13806 Write a function to search for a regular expression that matches two
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13807 or more blank lines in sequence.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13808
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13809 @item
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13810 Write a function to search for duplicated words, such as `the the'.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13811 @xref{Regexps, , Syntax of Regular Expressions, emacs, The GNU Emacs
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13812 Manual}, for information on how to write a regexp (a regular
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13813 expression) to match a string that is composed of two identical
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13814 halves. You can devise several regexps; some are better than others.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13815 The function I use is described in an appendix, along with several
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13816 regexps. @xref{the-the, , @code{the-the} Duplicated Words Function}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13817 @end itemize
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13818
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13819 @node Counting Words, Words in a defun, Regexp Search, Top
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13820 @chapter Counting: Repetition and Regexps
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13821 @cindex Repetition for word counting
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13822 @cindex Regular expressions for word counting
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13823
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13824 Repetition and regular expression searches are powerful tools that you
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13825 often use when you write code in Emacs Lisp. This chapter illustrates
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13826 the use of regular expression searches through the construction of
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13827 word count commands using @code{while} loops and recursion.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13828
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13829 @menu
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13830 * Why Count Words::
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13831 * count-words-region:: Use a regexp, but find a problem.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13832 * recursive-count-words:: Start with case of no words in region.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13833 * Counting Exercise::
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13834 @end menu
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13835
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13836 @node Why Count Words, count-words-region, Counting Words, Counting Words
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13837 @ifnottex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13838 @unnumberedsec Counting words
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13839 @end ifnottex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13840
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13841 The standard Emacs distribution contains a function for counting the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13842 number of lines within a region. However, there is no corresponding
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13843 function for counting words.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13844
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13845 Certain types of writing ask you to count words. Thus, if you write
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13846 an essay, you may be limited to 800 words; if you write a novel, you
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13847 may discipline yourself to write 1000 words a day. It seems odd to me
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13848 that Emacs lacks a word count command. Perhaps people use Emacs
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13849 mostly for code or types of documentation that do not require word
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13850 counts; or perhaps they restrict themselves to the operating system
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13851 word count command, @code{wc}. Alternatively, people may follow
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13852 the publishers' convention and compute a word count by dividing the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13853 number of characters in a document by five. In any event, here are
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13854 commands to count words.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13855
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13856 @node count-words-region, recursive-count-words, Why Count Words, Counting Words
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13857 @comment node-name, next, previous, up
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13858 @section The @code{count-words-region} Function
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13859 @findex count-words-region
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13860
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13861 A word count command could count words in a line, paragraph, region,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13862 or buffer. What should the command cover? You could design the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13863 command to count the number of words in a complete buffer. However,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13864 the Emacs tradition encourages flexibility---you may want to count
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13865 words in just a section, rather than all of a buffer. So it makes
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13866 more sense to design the command to count the number of words in a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13867 region. Once you have a @code{count-words-region} command, you can,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13868 if you wish, count words in a whole buffer by marking it with
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13869 @w{@kbd{C-x h}} (@code{mark-whole-buffer}).
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13870
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13871 Clearly, counting words is a repetitive act: starting from the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13872 beginning of the region, you count the first word, then the second
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13873 word, then the third word, and so on, until you reach the end of the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13874 region. This means that word counting is ideally suited to recursion
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13875 or to a @code{while} loop.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13876
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13877 @menu
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13878 * Design count-words-region:: The definition using a @code{while} loop.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13879 * Whitespace Bug:: The Whitespace Bug in @code{count-words-region}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13880 @end menu
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13881
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13882 @node Design count-words-region, Whitespace Bug, count-words-region, count-words-region
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13883 @ifnottex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13884 @unnumberedsubsec Designing @code{count-words-region}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13885 @end ifnottex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13886
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13887 First, we will implement the word count command with a @code{while}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13888 loop, then with recursion. The command will, of course, be
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13889 interactive.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13890
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13891 @need 800
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13892 The template for an interactive function definition is, as always:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13893
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13894 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13895 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13896 (defun @var{name-of-function} (@var{argument-list})
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13897 "@var{documentation}@dots{}"
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13898 (@var{interactive-expression}@dots{})
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13899 @var{body}@dots{})
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13900 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13901 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13902
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13903 What we need to do is fill in the slots.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13904
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13905 The name of the function should be self-explanatory and similar to the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13906 existing @code{count-lines-region} name. This makes the name easier
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13907 to remember. @code{count-words-region} is a good choice.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13908
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13909 The function counts words within a region. This means that the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13910 argument list must contain symbols that are bound to the two
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13911 positions, the beginning and end of the region. These two positions
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13912 can be called @samp{beginning} and @samp{end} respectively. The first
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13913 line of the documentation should be a single sentence, since that is
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13914 all that is printed as documentation by a command such as
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13915 @code{apropos}. The interactive expression will be of the form
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13916 @samp{(interactive "r")}, since that will cause Emacs to pass the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13917 beginning and end of the region to the function's argument list. All
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13918 this is routine.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13919
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13920 The body of the function needs to be written to do three tasks:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13921 first, to set up conditions under which the @code{while} loop can
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13922 count words, second, to run the @code{while} loop, and third, to send
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13923 a message to the user.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13924
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13925 When a user calls @code{count-words-region}, point may be at the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13926 beginning or the end of the region. However, the counting process
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13927 must start at the beginning of the region. This means we will want
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13928 to put point there if it is not already there. Executing
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13929 @code{(goto-char beginning)} ensures this. Of course, we will want to
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13930 return point to its expected position when the function finishes its
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13931 work. For this reason, the body must be enclosed in a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13932 @code{save-excursion} expression.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13933
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13934 The central part of the body of the function consists of a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13935 @code{while} loop in which one expression jumps point forward word by
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13936 word, and another expression counts those jumps. The true-or-false-test
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13937 of the @code{while} loop should test true so long as point should jump
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13938 forward, and false when point is at the end of the region.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13939
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13940 We could use @code{(forward-word 1)} as the expression for moving point
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13941 forward word by word, but it is easier to see what Emacs identifies as a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13942 `word' if we use a regular expression search.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13943
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13944 A regular expression search that finds the pattern for which it is
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13945 searching leaves point after the last character matched. This means
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13946 that a succession of successful word searches will move point forward
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13947 word by word.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13948
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13949 As a practical matter, we want the regular expression search to jump
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13950 over whitespace and punctuation between words as well as over the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13951 words themselves. A regexp that refuses to jump over interword
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13952 whitespace would never jump more than one word! This means that
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13953 the regexp should include the whitespace and punctuation that follows
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13954 a word, if any, as well as the word itself. (A word may end a buffer
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13955 and not have any following whitespace or punctuation, so that part of
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13956 the regexp must be optional.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13957
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13958 Thus, what we want for the regexp is a pattern defining one or more
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13959 word constituent characters followed, optionally, by one or more
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13960 characters that are not word constituents. The regular expression for
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13961 this is:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13962
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13963 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13964 \w+\W*
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13965 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13966
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13967 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13968 The buffer's syntax table determines which characters are and are not
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13969 word constituents. (@xref{Syntax, , What Constitutes a Word or
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13970 Symbol?}, for more about syntax. Also, see @ref{Syntax, Syntax, The
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13971 Syntax Table, emacs, The GNU Emacs Manual}, and @ref{Syntax Tables, ,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13972 Syntax Tables, elisp, The GNU Emacs Lisp Reference Manual}.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13973
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13974 @need 800
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13975 The search expression looks like this:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13976
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13977 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13978 (re-search-forward "\\w+\\W*")
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13979 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13980
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13981 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13982 (Note that paired backslashes precede the @samp{w} and @samp{W}. A
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13983 single backslash has special meaning to the Emacs Lisp interpreter.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13984 It indicates that the following character is interpreted differently
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13985 than usual. For example, the two characters, @samp{\n}, stand for
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13986 @samp{newline}, rather than for a backslash followed by @samp{n}. Two
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13987 backslashes in a row stand for an ordinary, `unspecial' backslash, so
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13988 Emacs Lisp interpreter ends of seeing a single backslash followed by a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13989 letter. So it discovers the letter is special.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13990
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13991 We need a counter to count how many words there are; this variable
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13992 must first be set to 0 and then incremented each time Emacs goes
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13993 around the @code{while} loop. The incrementing expression is simply:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13994
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13995 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13996 (setq count (1+ count))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13997 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13998
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13999 Finally, we want to tell the user how many words there are in the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14000 region. The @code{message} function is intended for presenting this
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14001 kind of information to the user. The message has to be phrased so
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14002 that it reads properly regardless of how many words there are in the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14003 region: we don't want to say that ``there are 1 words in the region''.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14004 The conflict between singular and plural is ungrammatical. We can
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14005 solve this problem by using a conditional expression that evaluates
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14006 different messages depending on the number of words in the region.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14007 There are three possibilities: no words in the region, one word in the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14008 region, and more than one word. This means that the @code{cond}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14009 special form is appropriate.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14010
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14011 @need 1500
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14012 All this leads to the following function definition:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14013
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14014 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14015 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14016 ;;; @r{First version; has bugs!}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14017 (defun count-words-region (beginning end)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14018 "Print number of words in the region.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14019 Words are defined as at least one word-constituent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14020 character followed by at least one character that
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14021 is not a word-constituent. The buffer's syntax
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14022 table determines which characters these are."
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14023 (interactive "r")
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14024 (message "Counting words in region ... ")
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14025 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14026
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14027 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14028 ;;; @r{1. Set up appropriate conditions.}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14029 (save-excursion
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14030 (goto-char beginning)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14031 (let ((count 0))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14032 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14033
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14034 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14035 ;;; @r{2. Run the} while @r{loop.}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14036 (while (< (point) end)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14037 (re-search-forward "\\w+\\W*")
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14038 (setq count (1+ count)))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14039 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14040
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14041 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14042 ;;; @r{3. Send a message to the user.}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14043 (cond ((zerop count)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14044 (message
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14045 "The region does NOT have any words."))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14046 ((= 1 count)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14047 (message
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14048 "The region has 1 word."))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14049 (t
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14050 (message
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14051 "The region has %d words." count))))))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14052 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14053 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14054
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14055 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14056 As written, the function works, but not in all circumstances.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14057
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14058 @node Whitespace Bug, , Design count-words-region, count-words-region
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14059 @comment node-name, next, previous, up
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14060 @subsection The Whitespace Bug in @code{count-words-region}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14061
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14062 The @code{count-words-region} command described in the preceding
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14063 section has two bugs, or rather, one bug with two manifestations.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14064 First, if you mark a region containing only whitespace in the middle
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14065 of some text, the @code{count-words-region} command tells you that the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14066 region contains one word! Second, if you mark a region containing
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14067 only whitespace at the end of the buffer or the accessible portion of
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14068 a narrowed buffer, the command displays an error message that looks
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14069 like this:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14070
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14071 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14072 Search failed: "\\w+\\W*"
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14073 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14074
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14075 If you are reading this in Info in GNU Emacs, you can test for these
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14076 bugs yourself.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14077
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14078 First, evaluate the function in the usual manner to install it.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14079 @ifinfo
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14080 Here is a copy of the definition. Place your cursor after the closing
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14081 parenthesis and type @kbd{C-x C-e} to install it.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14082
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14083 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14084 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14085 ;; @r{First version; has bugs!}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14086 (defun count-words-region (beginning end)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14087 "Print number of words in the region.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14088 Words are defined as at least one word-constituent character followed
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14089 by at least one character that is not a word-constituent. The buffer's
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14090 syntax table determines which characters these are."
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14091 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14092 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14093 (interactive "r")
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14094 (message "Counting words in region ... ")
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14095 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14096
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14097 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14098 ;;; @r{1. Set up appropriate conditions.}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14099 (save-excursion
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14100 (goto-char beginning)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14101 (let ((count 0))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14102 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14103
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14104 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14105 ;;; @r{2. Run the} while @r{loop.}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14106 (while (< (point) end)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14107 (re-search-forward "\\w+\\W*")
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14108 (setq count (1+ count)))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14109 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14110
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14111 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14112 ;;; @r{3. Send a message to the user.}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14113 (cond ((zerop count)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14114 (message "The region does NOT have any words."))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14115 ((= 1 count) (message "The region has 1 word."))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14116 (t (message "The region has %d words." count))))))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14117 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14118 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14119 @end ifinfo
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14120
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14121 @need 1000
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14122 If you wish, you can also install this keybinding by evaluating it:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14123
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14124 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14125 (global-set-key "\C-c=" 'count-words-region)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14126 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14127
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14128 To conduct the first test, set mark and point to the beginning and end
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14129 of the following line and then type @kbd{C-c =} (or @kbd{M-x
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14130 count-words-region} if you have not bound @kbd{C-c =}):
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14131
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14132 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14133 one two three
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14134 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14135
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14136 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14137 Emacs will tell you, correctly, that the region has three words.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14138
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14139 Repeat the test, but place mark at the beginning of the line and place
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14140 point just @emph{before} the word @samp{one}. Again type the command
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14141 @kbd{C-c =} (or @kbd{M-x count-words-region}). Emacs should tell you
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14142 that the region has no words, since it is composed only of the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14143 whitespace at the beginning of the line. But instead Emacs tells you
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14144 that the region has one word!
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14145
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14146 For the third test, copy the sample line to the end of the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14147 @file{*scratch*} buffer and then type several spaces at the end of the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14148 line. Place mark right after the word @samp{three} and point at the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14149 end of line. (The end of the line will be the end of the buffer.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14150 Type @kbd{C-c =} (or @kbd{M-x count-words-region}) as you did before.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14151 Again, Emacs should tell you that the region has no words, since it is
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14152 composed only of the whitespace at the end of the line. Instead,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14153 Emacs displays an error message saying @samp{Search failed}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14154
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14155 The two bugs stem from the same problem.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14156
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14157 Consider the first manifestation of the bug, in which the command
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14158 tells you that the whitespace at the beginning of the line contains
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14159 one word. What happens is this: The @code{M-x count-words-region}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14160 command moves point to the beginning of the region. The @code{while}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14161 tests whether the value of point is smaller than the value of
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14162 @code{end}, which it is. Consequently, the regular expression search
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14163 looks for and finds the first word. It leaves point after the word.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14164 @code{count} is set to one. The @code{while} loop repeats; but this
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14165 time the value of point is larger than the value of @code{end}, the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14166 loop is exited; and the function displays a message saying the number
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14167 of words in the region is one. In brief, the regular expression
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14168 search looks for and finds the word even though it is outside
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14169 the marked region.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14170
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14171 In the second manifestation of the bug, the region is whitespace at
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14172 the end of the buffer. Emacs says @samp{Search failed}. What happens
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14173 is that the true-or-false-test in the @code{while} loop tests true, so
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14174 the search expression is executed. But since there are no more words
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14175 in the buffer, the search fails.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14176
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14177 In both manifestations of the bug, the search extends or attempts to
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14178 extend outside of the region.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14179
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14180 The solution is to limit the search to the region---this is a fairly
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14181 simple action, but as you may have come to expect, it is not quite as
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14182 simple as you might think.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14183
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14184 As we have seen, the @code{re-search-forward} function takes a search
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14185 pattern as its first argument. But in addition to this first,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14186 mandatory argument, it accepts three optional arguments. The optional
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14187 second argument bounds the search. The optional third argument, if
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14188 @code{t}, causes the function to return @code{nil} rather than signal
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14189 an error if the search fails. The optional fourth argument is a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14190 repeat count. (In Emacs, you can see a function's documentation by
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14191 typing @kbd{C-h f}, the name of the function, and then @key{RET}.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14192
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14193 In the @code{count-words-region} definition, the value of the end of
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14194 the region is held by the variable @code{end} which is passed as an
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14195 argument to the function. Thus, we can add @code{end} as an argument
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14196 to the regular expression search expression:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14197
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14198 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14199 (re-search-forward "\\w+\\W*" end)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14200 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14201
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14202 However, if you make only this change to the @code{count-words-region}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14203 definition and then test the new version of the definition on a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14204 stretch of whitespace, you will receive an error message saying
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14205 @samp{Search failed}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14206
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14207 What happens is this: the search is limited to the region, and fails
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14208 as you expect because there are no word-constituent characters in the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14209 region. Since it fails, we receive an error message. But we do not
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14210 want to receive an error message in this case; we want to receive the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14211 message that "The region does NOT have any words."
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14212
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14213 The solution to this problem is to provide @code{re-search-forward}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14214 with a third argument of @code{t}, which causes the function to return
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14215 @code{nil} rather than signal an error if the search fails.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14216
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14217 However, if you make this change and try it, you will see the message
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14218 ``Counting words in region ... '' and @dots{} you will keep on seeing
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14219 that message @dots{}, until you type @kbd{C-g} (@code{keyboard-quit}).
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14220
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14221 Here is what happens: the search is limited to the region, as before,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14222 and it fails because there are no word-constituent characters in the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14223 region, as expected. Consequently, the @code{re-search-forward}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14224 expression returns @code{nil}. It does nothing else. In particular,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14225 it does not move point, which it does as a side effect if it finds the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14226 search target. After the @code{re-search-forward} expression returns
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14227 @code{nil}, the next expression in the @code{while} loop is evaluated.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14228 This expression increments the count. Then the loop repeats. The
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14229 true-or-false-test tests true because the value of point is still less
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14230 than the value of end, since the @code{re-search-forward} expression
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14231 did not move point. @dots{} and the cycle repeats @dots{}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14232
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14233 The @code{count-words-region} definition requires yet another
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14234 modification, to cause the true-or-false-test of the @code{while} loop
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14235 to test false if the search fails. Put another way, there are two
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14236 conditions that must be satisfied in the true-or-false-test before the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14237 word count variable is incremented: point must still be within the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14238 region and the search expression must have found a word to count.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14239
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14240 Since both the first condition and the second condition must be true
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14241 together, the two expressions, the region test and the search
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14242 expression, can be joined with an @code{and} special form and embedded in
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14243 the @code{while} loop as the true-or-false-test, like this:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14244
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14245 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14246 (and (< (point) end) (re-search-forward "\\w+\\W*" end t))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14247 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14248
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14249 @c colon in printed section title causes problem in Info cross reference
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14250 @c also trouble with an overfull hbox
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14251 @iftex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14252 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14253 (For information about @code{and}, see
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14254 @ref{kill-new function, , The @code{kill-new} function}.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14255 @end iftex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14256 @ifinfo
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14257 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14258 (@xref{kill-new function, , The @code{kill-new} function}, for
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14259 information about @code{and}.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14260 @end ifinfo
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14261
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14262 The @code{re-search-forward} expression returns @code{t} if the search
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14263 succeeds and as a side effect moves point. Consequently, as words are
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14264 found, point is moved through the region. When the search expression
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14265 fails to find another word, or when point reaches the end of the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14266 region, the true-or-false-test tests false, the @code{while} loop
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14267 exits, and the @code{count-words-region} function displays one or
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14268 other of its messages.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14269
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14270 After incorporating these final changes, the @code{count-words-region}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14271 works without bugs (or at least, without bugs that I have found!).
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14272 Here is what it looks like:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14273
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14274 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14275 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14276 ;;; @r{Final version:} @code{while}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14277 (defun count-words-region (beginning end)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14278 "Print number of words in the region."
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14279 (interactive "r")
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14280 (message "Counting words in region ... ")
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14281 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14282
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14283 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14284 ;;; @r{1. Set up appropriate conditions.}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14285 (save-excursion
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14286 (let ((count 0))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14287 (goto-char beginning)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14288 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14289
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14290 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14291 ;;; @r{2. Run the} while @r{loop.}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14292 (while (and (< (point) end)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14293 (re-search-forward "\\w+\\W*" end t))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14294 (setq count (1+ count)))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14295 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14296
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14297 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14298 ;;; @r{3. Send a message to the user.}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14299 (cond ((zerop count)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14300 (message
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14301 "The region does NOT have any words."))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14302 ((= 1 count)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14303 (message
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14304 "The region has 1 word."))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14305 (t
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14306 (message
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14307 "The region has %d words." count))))))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14308 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14309 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14310
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14311 @node recursive-count-words, Counting Exercise, count-words-region, Counting Words
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14312 @comment node-name, next, previous, up
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14313 @section Count Words Recursively
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14314 @cindex Count words recursively
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14315 @cindex Recursively counting words
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14316 @cindex Words, counted recursively
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14317
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14318 You can write the function for counting words recursively as well as
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14319 with a @code{while} loop. Let's see how this is done.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14320
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14321 First, we need to recognize that the @code{count-words-region}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14322 function has three jobs: it sets up the appropriate conditions for
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14323 counting to occur; it counts the words in the region; and it sends a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14324 message to the user telling how many words there are.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14325
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14326 If we write a single recursive function to do everything, we will
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14327 receive a message for every recursive call. If the region contains 13
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14328 words, we will receive thirteen messages, one right after the other.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14329 We don't want this! Instead, we must write two functions to do the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14330 job, one of which (the recursive function) will be used inside of the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14331 other. One function will set up the conditions and display the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14332 message; the other will return the word count.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14333
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14334 Let us start with the function that causes the message to be displayed.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14335 We can continue to call this @code{count-words-region}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14336
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14337 This is the function that the user will call. It will be interactive.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14338 Indeed, it will be similar to our previous versions of this
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14339 function, except that it will call @code{recursive-count-words} to
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14340 determine how many words are in the region.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14341
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14342 @need 1250
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14343 We can readily construct a template for this function, based on our
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14344 previous versions:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14345
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14346 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14347 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14348 ;; @r{Recursive version; uses regular expression search}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14349 (defun count-words-region (beginning end)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14350 "@var{documentation}@dots{}"
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14351 (@var{interactive-expression}@dots{})
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14352 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14353 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14354
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14355 ;;; @r{1. Set up appropriate conditions.}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14356 (@var{explanatory message})
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14357 (@var{set-up functions}@dots{}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14358 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14359 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14360
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14361 ;;; @r{2. Count the words.}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14362 @var{recursive call}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14363 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14364 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14365
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14366 ;;; @r{3. Send a message to the user.}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14367 @var{message providing word count}))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14368 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14369 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14370
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14371 The definition looks straightforward, except that somehow the count
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14372 returned by the recursive call must be passed to the message
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14373 displaying the word count. A little thought suggests that this can be
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14374 done by making use of a @code{let} expression: we can bind a variable
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14375 in the varlist of a @code{let} expression to the number of words in
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14376 the region, as returned by the recursive call; and then the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14377 @code{cond} expression, using binding, can display the value to the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14378 user.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14379
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14380 Often, one thinks of the binding within a @code{let} expression as
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14381 somehow secondary to the `primary' work of a function. But in this
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14382 case, what you might consider the `primary' job of the function,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14383 counting words, is done within the @code{let} expression.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14384
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14385 @need 1250
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14386 Using @code{let}, the function definition looks like this:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14387
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14388 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14389 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14390 (defun count-words-region (beginning end)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14391 "Print number of words in the region."
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14392 (interactive "r")
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14393 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14394
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14395 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14396 ;;; @r{1. Set up appropriate conditions.}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14397 (message "Counting words in region ... ")
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14398 (save-excursion
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14399 (goto-char beginning)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14400 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14401
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14402 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14403 ;;; @r{2. Count the words.}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14404 (let ((count (recursive-count-words end)))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14405 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14406
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14407 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14408 ;;; @r{3. Send a message to the user.}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14409 (cond ((zerop count)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14410 (message
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14411 "The region does NOT have any words."))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14412 ((= 1 count)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14413 (message
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14414 "The region has 1 word."))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14415 (t
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14416 (message
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14417 "The region has %d words." count))))))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14418 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14419 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14420
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14421 Next, we need to write the recursive counting function.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14422
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14423 A recursive function has at least three parts: the `do-again-test', the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14424 `next-step-expression', and the recursive call.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14425
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14426 The do-again-test determines whether the function will or will not be
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14427 called again. Since we are counting words in a region and can use a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14428 function that moves point forward for every word, the do-again-test
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14429 can check whether point is still within the region. The do-again-test
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14430 should find the value of point and determine whether point is before,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14431 at, or after the value of the end of the region. We can use the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14432 @code{point} function to locate point. Clearly, we must pass the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14433 value of the end of the region to the recursive counting function as an
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14434 argument.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14435
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14436 In addition, the do-again-test should also test whether the search finds a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14437 word. If it does not, the function should not call itself again.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14438
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14439 The next-step-expression changes a value so that when the recursive
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14440 function is supposed to stop calling itself, it stops. More
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14441 precisely, the next-step-expression changes a value so that at the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14442 right time, the do-again-test stops the recursive function from
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14443 calling itself again. In this case, the next-step-expression can be
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14444 the expression that moves point forward, word by word.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14445
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14446 The third part of a recursive function is the recursive call.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14447
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14448 Somewhere, also, we also need a part that does the `work' of the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14449 function, a part that does the counting. A vital part!
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14450
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14451 @need 1250
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14452 But already, we have an outline of the recursive counting function:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14453
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14454 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14455 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14456 (defun recursive-count-words (region-end)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14457 "@var{documentation}@dots{}"
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14458 @var{do-again-test}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14459 @var{next-step-expression}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14460 @var{recursive call})
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14461 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14462 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14463
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14464 Now we need to fill in the slots. Let's start with the simplest cases
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14465 first: if point is at or beyond the end of the region, there cannot
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14466 be any words in the region, so the function should return zero.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14467 Likewise, if the search fails, there are no words to count, so the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14468 function should return zero.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14469
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14470 On the other hand, if point is within the region and the search
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14471 succeeds, the function should call itself again.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14472
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14473 @need 800
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14474 Thus, the do-again-test should look like this:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14475
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14476 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14477 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14478 (and (< (point) region-end)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14479 (re-search-forward "\\w+\\W*" region-end t))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14480 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14481 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14482
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14483 Note that the search expression is part of the do-again-test---the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14484 function returns @code{t} if its search succeeds and @code{nil} if it
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14485 fails. (@xref{Whitespace Bug, , The Whitespace Bug in
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14486 @code{count-words-region}}, for an explanation of how
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14487 @code{re-search-forward} works.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14488
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14489 The do-again-test is the true-or-false test of an @code{if} clause.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14490 Clearly, if the do-again-test succeeds, the then-part of the @code{if}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14491 clause should call the function again; but if it fails, the else-part
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14492 should return zero since either point is outside the region or the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14493 search failed because there were no words to find.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14494
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14495 But before considering the recursive call, we need to consider the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14496 next-step-expression. What is it? Interestingly, it is the search
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14497 part of the do-again-test.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14498
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14499 In addition to returning @code{t} or @code{nil} for the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14500 do-again-test, @code{re-search-forward} moves point forward as a side
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14501 effect of a successful search. This is the action that changes the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14502 value of point so that the recursive function stops calling itself
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14503 when point completes its movement through the region. Consequently,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14504 the @code{re-search-forward} expression is the next-step-expression.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14505
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14506 @need 1200
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14507 In outline, then, the body of the @code{recursive-count-words}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14508 function looks like this:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14509
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14510 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14511 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14512 (if @var{do-again-test-and-next-step-combined}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14513 ;; @r{then}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14514 @var{recursive-call-returning-count}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14515 ;; @r{else}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14516 @var{return-zero})
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14517 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14518 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14519
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14520 How to incorporate the mechanism that counts?
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14521
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14522 If you are not used to writing recursive functions, a question like
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14523 this can be troublesome. But it can and should be approached
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14524 systematically.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14525
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14526 We know that the counting mechanism should be associated in some way
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14527 with the recursive call. Indeed, since the next-step-expression moves
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14528 point forward by one word, and since a recursive call is made for
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14529 each word, the counting mechanism must be an expression that adds one
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14530 to the value returned by a call to @code{recursive-count-words}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14531
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14532 @need 800
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14533 Consider several cases:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14534
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14535 @itemize @bullet
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14536 @item
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14537 If there are two words in the region, the function should return
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14538 a value resulting from adding one to the value returned when it counts
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14539 the first word, plus the number returned when it counts the remaining
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14540 words in the region, which in this case is one.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14541
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14542 @item
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14543 If there is one word in the region, the function should return
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14544 a value resulting from adding one to the value returned when it counts
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14545 that word, plus the number returned when it counts the remaining
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14546 words in the region, which in this case is zero.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14547
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14548 @item
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14549 If there are no words in the region, the function should return zero.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14550 @end itemize
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14551
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14552 From the sketch we can see that the else-part of the @code{if} returns
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14553 zero for the case of no words. This means that the then-part of the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14554 @code{if} must return a value resulting from adding one to the value
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14555 returned from a count of the remaining words.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14556
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14557 @need 1200
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14558 The expression will look like this, where @code{1+} is a function that
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14559 adds one to its argument.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14560
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14561 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14562 (1+ (recursive-count-words region-end))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14563 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14564
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14565 @need 1200
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14566 The whole @code{recursive-count-words} function will then look like
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14567 this:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14568
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14569 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14570 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14571 (defun recursive-count-words (region-end)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14572 "@var{documentation}@dots{}"
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14573
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14574 ;;; @r{1. do-again-test}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14575 (if (and (< (point) region-end)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14576 (re-search-forward "\\w+\\W*" region-end t))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14577 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14578
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14579 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14580 ;;; @r{2. then-part: the recursive call}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14581 (1+ (recursive-count-words region-end))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14582
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14583 ;;; @r{3. else-part}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14584 0))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14585 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14586 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14587
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14588 @need 1250
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14589 Let's examine how this works:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14590
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14591 If there are no words in the region, the else part of the @code{if}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14592 expression is evaluated and consequently the function returns zero.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14593
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14594 If there is one word in the region, the value of point is less than
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14595 the value of @code{region-end} and the search succeeds. In this case,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14596 the true-or-false-test of the @code{if} expression tests true, and the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14597 then-part of the @code{if} expression is evaluated. The counting
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14598 expression is evaluated. This expression returns a value (which will
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14599 be the value returned by the whole function) that is the sum of one
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14600 added to the value returned by a recursive call.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14601
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14602 Meanwhile, the next-step-expression has caused point to jump over the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14603 first (and in this case only) word in the region. This means that
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14604 when @code{(recursive-count-words region-end)} is evaluated a second
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14605 time, as a result of the recursive call, the value of point will be
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14606 equal to or greater than the value of region end. So this time,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14607 @code{recursive-count-words} will return zero. The zero will be added
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14608 to one, and the original evaluation of @code{recursive-count-words}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14609 will return one plus zero, which is one, which is the correct amount.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14610
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14611 Clearly, if there are two words in the region, the first call to
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14612 @code{recursive-count-words} returns one added to the value returned
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14613 by calling @code{recursive-count-words} on a region containing the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14614 remaining word---that is, it adds one to one, producing two, which is
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14615 the correct amount.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14616
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14617 Similarly, if there are three words in the region, the first call to
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14618 @code{recursive-count-words} returns one added to the value returned
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14619 by calling @code{recursive-count-words} on a region containing the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14620 remaining two words---and so on and so on.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14621
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14622 @need 1250
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14623 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14624 With full documentation the two functions look like this:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14625
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14626 @need 1250
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14627 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14628 The recursive function:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14629
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14630 @findex recursive-count-words
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14631 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14632 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14633 (defun recursive-count-words (region-end)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14634 "Number of words between point and REGION-END."
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14635 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14636
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14637 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14638 ;;; @r{1. do-again-test}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14639 (if (and (< (point) region-end)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14640 (re-search-forward "\\w+\\W*" region-end t))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14641 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14642
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14643 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14644 ;;; @r{2. then-part: the recursive call}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14645 (1+ (recursive-count-words region-end))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14646
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14647 ;;; @r{3. else-part}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14648 0))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14649 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14650 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14651
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14652 @need 800
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14653 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14654 The wrapper:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14655
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14656 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14657 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14658 ;;; @r{Recursive version}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14659 (defun count-words-region (beginning end)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14660 "Print number of words in the region.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14661 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14662
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14663 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14664 Words are defined as at least one word-constituent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14665 character followed by at least one character that is
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14666 not a word-constituent. The buffer's syntax table
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14667 determines which characters these are."
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14668 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14669 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14670 (interactive "r")
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14671 (message "Counting words in region ... ")
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14672 (save-excursion
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14673 (goto-char beginning)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14674 (let ((count (recursive-count-words end)))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14675 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14676 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14677 (cond ((zerop count)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14678 (message
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14679 "The region does NOT have any words."))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14680 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14681 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14682 ((= 1 count)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14683 (message "The region has 1 word."))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14684 (t
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14685 (message
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14686 "The region has %d words." count))))))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14687 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14688 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14689
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14690 @node Counting Exercise, , recursive-count-words, Counting Words
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14691 @section Exercise: Counting Punctuation
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14692
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14693 Using a @code{while} loop, write a function to count the number of
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14694 punctuation marks in a region---period, comma, semicolon, colon,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14695 exclamation mark, and question mark. Do the same using recursion.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14696
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14697 @node Words in a defun, Readying a Graph, Counting Words, Top
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14698 @chapter Counting Words in a @code{defun}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14699 @cindex Counting words in a @code{defun}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14700 @cindex Word counting in a @code{defun}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14701
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14702 Our next project is to count the number of words in a function
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14703 definition. Clearly, this can be done using some variant of
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14704 @code{count-word-region}. @xref{Counting Words, , Counting Words:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14705 Repetition and Regexps}. If we are just going to count the words in
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14706 one definition, it is easy enough to mark the definition with the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14707 @kbd{C-M-h} (@code{mark-defun}) command, and then call
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14708 @code{count-word-region}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14709
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14710 However, I am more ambitious: I want to count the words and symbols in
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14711 every definition in the Emacs sources and then print a graph that
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14712 shows how many functions there are of each length: how many contain 40
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14713 to 49 words or symbols, how many contain 50 to 59 words or symbols,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14714 and so on. I have often been curious how long a typical function is,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14715 and this will tell.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14716
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14717 @menu
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14718 * Divide and Conquer::
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14719 * Words and Symbols:: What to count?
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14720 * Syntax:: What constitutes a word or symbol?
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14721 * count-words-in-defun:: Very like @code{count-words}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14722 * Several defuns:: Counting several defuns in a file.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14723 * Find a File:: Do you want to look at a file?
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14724 * lengths-list-file:: A list of the lengths of many definitions.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14725 * Several files:: Counting in definitions in different files.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14726 * Several files recursively:: Recursively counting in different files.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14727 * Prepare the data:: Prepare the data for display in a graph.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14728 @end menu
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14729
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14730 @node Divide and Conquer, Words and Symbols, Words in a defun, Words in a defun
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14731 @ifnottex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14732 @unnumberedsec Divide and Conquer
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14733 @end ifnottex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14734
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14735 Described in one phrase, the histogram project is daunting; but
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14736 divided into numerous small steps, each of which we can take one at a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14737 time, the project becomes less fearsome. Let us consider what the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14738 steps must be:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14739
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14740 @itemize @bullet
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14741 @item
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14742 First, write a function to count the words in one definition. This
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14743 includes the problem of handling symbols as well as words.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14744
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14745 @item
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14746 Second, write a function to list the numbers of words in each function
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14747 in a file. This function can use the @code{count-words-in-defun}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14748 function.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14749
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14750 @item
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14751 Third, write a function to list the numbers of words in each function
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14752 in each of several files. This entails automatically finding the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14753 various files, switching to them, and counting the words in the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14754 definitions within them.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14755
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14756 @item
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14757 Fourth, write a function to convert the list of numbers that we
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14758 created in step three to a form that will be suitable for printing as
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14759 a graph.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14760
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14761 @item
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14762 Fifth, write a function to print the results as a graph.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14763 @end itemize
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14764
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14765 This is quite a project! But if we take each step slowly, it will not
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14766 be difficult.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14767
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14768 @node Words and Symbols, Syntax, Divide and Conquer, Words in a defun
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14769 @section What to Count?
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14770 @cindex Words and symbols in defun
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14771
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14772 When we first start thinking about how to count the words in a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14773 function definition, the first question is (or ought to be) what are
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14774 we going to count? When we speak of `words' with respect to a Lisp
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14775 function definition, we are actually speaking, in large part, of
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14776 `symbols'. For example, the following @code{multiply-by-seven}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14777 function contains the five symbols @code{defun},
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14778 @code{multiply-by-seven}, @code{number}, @code{*}, and @code{7}. In
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14779 addition, in the documentation string, it contains the four words
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14780 @samp{Multiply}, @samp{NUMBER}, @samp{by}, and @samp{seven}. The
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14781 symbol @samp{number} is repeated, so the definition contains a total
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14782 of ten words and symbols.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14783
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14784 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14785 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14786 (defun multiply-by-seven (number)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14787 "Multiply NUMBER by seven."
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14788 (* 7 number))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14789 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14790 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14791
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14792 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14793 However, if we mark the @code{multiply-by-seven} definition with
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14794 @kbd{C-M-h} (@code{mark-defun}), and then call
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14795 @code{count-words-region} on it, we will find that
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14796 @code{count-words-region} claims the definition has eleven words, not
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14797 ten! Something is wrong!
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14798
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14799 The problem is twofold: @code{count-words-region} does not count the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14800 @samp{*} as a word, and it counts the single symbol,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14801 @code{multiply-by-seven}, as containing three words. The hyphens are
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14802 treated as if they were interword spaces rather than intraword
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14803 connectors: @samp{multiply-by-seven} is counted as if it were written
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14804 @samp{multiply by seven}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14805
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14806 The cause of this confusion is the regular expression search within
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14807 the @code{count-words-region} definition that moves point forward word
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14808 by word. In the canonical version of @code{count-words-region}, the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14809 regexp is:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14810
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14811 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14812 "\\w+\\W*"
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14813 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14814
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14815 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14816 This regular expression is a pattern defining one or more word
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14817 constituent characters possibly followed by one or more characters
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14818 that are not word constituents. What is meant by `word constituent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14819 characters' brings us to the issue of syntax, which is worth a section
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14820 of its own.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14821
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14822 @node Syntax, count-words-in-defun, Words and Symbols, Words in a defun
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14823 @section What Constitutes a Word or Symbol?
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14824 @cindex Syntax categories and tables
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14825
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14826 Emacs treats different characters as belonging to different
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14827 @dfn{syntax categories}. For example, the regular expression,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14828 @samp{\\w+}, is a pattern specifying one or more @emph{word
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14829 constituent} characters. Word constituent characters are members of
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14830 one syntax category. Other syntax categories include the class of
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14831 punctuation characters, such as the period and the comma, and the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14832 class of whitespace characters, such as the blank space and the tab
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14833 character. (For more information, see @ref{Syntax, Syntax, The Syntax
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14834 Table, emacs, The GNU Emacs Manual}, and @ref{Syntax Tables, , Syntax
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14835 Tables, elisp, The GNU Emacs Lisp Reference Manual}.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14836
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14837 Syntax tables specify which characters belong to which categories.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14838 Usually, a hyphen is not specified as a `word constituent character'.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14839 Instead, it is specified as being in the `class of characters that are
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14840 part of symbol names but not words.' This means that the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14841 @code{count-words-region} function treats it in the same way it treats
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14842 an interword white space, which is why @code{count-words-region}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14843 counts @samp{multiply-by-seven} as three words.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14844
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14845 There are two ways to cause Emacs to count @samp{multiply-by-seven} as
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14846 one symbol: modify the syntax table or modify the regular expression.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14847
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14848 We could redefine a hyphen as a word constituent character by
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14849 modifying the syntax table that Emacs keeps for each mode. This
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14850 action would serve our purpose, except that a hyphen is merely the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14851 most common character within symbols that is not typically a word
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14852 constituent character; there are others, too.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14853
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14854 Alternatively, we can redefine the regular expression used in the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14855 @code{count-words} definition so as to include symbols. This
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14856 procedure has the merit of clarity, but the task is a little tricky.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14857
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14858 @need 1200
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14859 The first part is simple enough: the pattern must match ``at least one
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14860 character that is a word or symbol constituent''. Thus:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14861
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14862 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14863 "\\(\\w\\|\\s_\\)+"
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14864 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14865
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14866 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14867 The @samp{\\(} is the first part of the grouping construct that
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14868 includes the @samp{\\w} and the @samp{\\s_} as alternatives, separated
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14869 by the @samp{\\|}. The @samp{\\w} matches any word-constituent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14870 character and the @samp{\\s_} matches any character that is part of a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14871 symbol name but not a word-constituent character. The @samp{+}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14872 following the group indicates that the word or symbol constituent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14873 characters must be matched at least once.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14874
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14875 However, the second part of the regexp is more difficult to design.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14876 What we want is to follow the first part with ``optionally one or more
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14877 characters that are not constituents of a word or symbol''. At first,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14878 I thought I could define this with the following:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14879
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14880 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14881 "\\(\\W\\|\\S_\\)*"
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14882 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14883
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14884 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14885 The upper case @samp{W} and @samp{S} match characters that are
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14886 @emph{not} word or symbol constituents. Unfortunately, this
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14887 expression matches any character that is either not a word constituent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14888 or not a symbol constituent. This matches any character!
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14889
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14890 I then noticed that every word or symbol in my test region was
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14891 followed by white space (blank space, tab, or newline). So I tried
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14892 placing a pattern to match one or more blank spaces after the pattern
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14893 for one or more word or symbol constituents. This failed, too. Words
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14894 and symbols are often separated by whitespace, but in actual code
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14895 parentheses may follow symbols and punctuation may follow words. So
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14896 finally, I designed a pattern in which the word or symbol constituents
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14897 are followed optionally by characters that are not white space and
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14898 then followed optionally by white space.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14899
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14900 @need 800
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14901 Here is the full regular expression:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14902
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14903 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14904 "\\(\\w\\|\\s_\\)+[^ \t\n]*[ \t\n]*"
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14905 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14906
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14907 @node count-words-in-defun, Several defuns, Syntax, Words in a defun
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14908 @section The @code{count-words-in-defun} Function
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14909 @cindex Counting words in a @code{defun}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14910
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14911 We have seen that there are several ways to write a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14912 @code{count-word-region} function. To write a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14913 @code{count-words-in-defun}, we need merely adapt one of these
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14914 versions.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14915
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14916 The version that uses a @code{while} loop is easy to understand, so I
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14917 am going to adapt that. Because @code{count-words-in-defun} will be
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14918 part of a more complex program, it need not be interactive and it need
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14919 not display a message but just return the count. These considerations
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14920 simplify the definition a little.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14921
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14922 On the other hand, @code{count-words-in-defun} will be used within a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14923 buffer that contains function definitions. Consequently, it is
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14924 reasonable to ask that the function determine whether it is called
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14925 when point is within a function definition, and if it is, to return
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14926 the count for that definition. This adds complexity to the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14927 definition, but saves us from needing to pass arguments to the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14928 function.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14929
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14930 @need 1250
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14931 These considerations lead us to prepare the following template:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14932
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14933 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14934 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14935 (defun count-words-in-defun ()
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14936 "@var{documentation}@dots{}"
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14937 (@var{set up}@dots{}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14938 (@var{while loop}@dots{})
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14939 @var{return count})
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14940 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14941 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14942
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14943 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14944 As usual, our job is to fill in the slots.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14945
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14946 First, the set up.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14947
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14948 We are presuming that this function will be called within a buffer
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14949 containing function definitions. Point will either be within a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14950 function definition or not. For @code{count-words-in-defun} to work,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14951 point must move to the beginning of the definition, a counter must
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14952 start at zero, and the counting loop must stop when point reaches the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14953 end of the definition.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14954
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14955 The @code{beginning-of-defun} function searches backwards for an
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14956 opening delimiter such as a @samp{(} at the beginning of a line, and
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14957 moves point to that position, or else to the limit of the search. In
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14958 practice, this means that @code{beginning-of-defun} moves point to the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14959 beginning of an enclosing or preceding function definition, or else to
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14960 the beginning of the buffer. We can use @code{beginning-of-defun} to
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14961 place point where we wish to start.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14962
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14963 The @code{while} loop requires a counter to keep track of the words or
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14964 symbols being counted. A @code{let} expression can be used to create
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14965 a local variable for this purpose, and bind it to an initial value of zero.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14966
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14967 The @code{end-of-defun} function works like @code{beginning-of-defun}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14968 except that it moves point to the end of the definition.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14969 @code{end-of-defun} can be used as part of an expression that
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14970 determines the position of the end of the definition.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14971
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14972 The set up for @code{count-words-in-defun} takes shape rapidly: first
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14973 we move point to the beginning of the definition, then we create a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14974 local variable to hold the count, and finally, we record the position
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14975 of the end of the definition so the @code{while} loop will know when to stop
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14976 looping.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14977
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14978 @need 1250
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14979 The code looks like this:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14980
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14981 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14982 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14983 (beginning-of-defun)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14984 (let ((count 0)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14985 (end (save-excursion (end-of-defun) (point))))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14986 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14987 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14988
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14989 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14990 The code is simple. The only slight complication is likely to concern
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14991 @code{end}: it is bound to the position of the end of the definition
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14992 by a @code{save-excursion} expression that returns the value of point
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14993 after @code{end-of-defun} temporarily moves it to the end of the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14994 definition.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14995
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14996 The second part of the @code{count-words-in-defun}, after the set up,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14997 is the @code{while} loop.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14998
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14999 The loop must contain an expression that jumps point forward word by
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15000 word and symbol by symbol, and another expression that counts the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15001 jumps. The true-or-false-test for the @code{while} loop should test
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15002 true so long as point should jump forward, and false when point is at
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15003 the end of the definition. We have already redefined the regular
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15004 expression for this (@pxref{Syntax}), so the loop is straightforward:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15005
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15006 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15007 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15008 (while (and (< (point) end)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15009 (re-search-forward
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15010 "\\(\\w\\|\\s_\\)+[^ \t\n]*[ \t\n]*" end t)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15011 (setq count (1+ count)))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15012 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15013 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15014
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15015 The third part of the function definition returns the count of words
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15016 and symbols. This part is the last expression within the body of the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15017 @code{let} expression, and can be, very simply, the local variable
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15018 @code{count}, which when evaluated returns the count.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15019
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15020 @need 1250
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15021 Put together, the @code{count-words-in-defun} definition looks like this:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15022
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15023 @findex count-words-in-defun
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15024 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15025 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15026 (defun count-words-in-defun ()
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15027 "Return the number of words and symbols in a defun."
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15028 (beginning-of-defun)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15029 (let ((count 0)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15030 (end (save-excursion (end-of-defun) (point))))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15031 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15032 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15033 (while
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15034 (and (< (point) end)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15035 (re-search-forward
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15036 "\\(\\w\\|\\s_\\)+[^ \t\n]*[ \t\n]*"
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15037 end t))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15038 (setq count (1+ count)))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15039 count))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15040 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15041 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15042
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15043 How to test this? The function is not interactive, but it is easy to
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15044 put a wrapper around the function to make it interactive; we can use
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15045 almost the same code as for the recursive version of
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15046 @code{count-words-region}:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15047
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15048 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15049 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15050 ;;; @r{Interactive version.}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15051 (defun count-words-defun ()
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15052 "Number of words and symbols in a function definition."
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15053 (interactive)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15054 (message
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15055 "Counting words and symbols in function definition ... ")
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15056 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15057 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15058 (let ((count (count-words-in-defun)))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15059 (cond
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15060 ((zerop count)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15061 (message
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15062 "The definition does NOT have any words or symbols."))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15063 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15064 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15065 ((= 1 count)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15066 (message
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15067 "The definition has 1 word or symbol."))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15068 (t
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15069 (message
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15070 "The definition has %d words or symbols." count)))))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15071 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15072 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15073
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15074 @need 800
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15075 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15076 Let's re-use @kbd{C-c =} as a convenient keybinding:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15077
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15078 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15079 (global-set-key "\C-c=" 'count-words-defun)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15080 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15081
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15082 Now we can try out @code{count-words-defun}: install both
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15083 @code{count-words-in-defun} and @code{count-words-defun}, and set the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15084 keybinding, and then place the cursor within the following definition:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15085
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15086 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15087 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15088 (defun multiply-by-seven (number)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15089 "Multiply NUMBER by seven."
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15090 (* 7 number))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15091 @result{} 10
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15092 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15093 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15094
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15095 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15096 Success! The definition has 10 words and symbols.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15097
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15098 The next problem is to count the numbers of words and symbols in
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15099 several definitions within a single file.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15100
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15101 @node Several defuns, Find a File, count-words-in-defun, Words in a defun
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15102 @section Count Several @code{defuns} Within a File
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15103
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15104 A file such as @file{simple.el} may have a hundred or more function
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15105 definitions within it. Our long term goal is to collect statistics on
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15106 many files, but as a first step, our immediate goal is to collect
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15107 statistics on one file.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15108
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15109 The information will be a series of numbers, each number being the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15110 length of a function definition. We can store the numbers in a list.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15111
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15112 We know that we will want to incorporate the information regarding one
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15113 file with information about many other files; this means that the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15114 function for counting definition lengths within one file need only
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15115 return the list of lengths. It need not and should not display any
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15116 messages.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15117
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15118 The word count commands contain one expression to jump point forward
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15119 word by word and another expression to count the jumps. The function
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15120 to return the lengths of definitions can be designed to work the same
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15121 way, with one expression to jump point forward definition by
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15122 definition and another expression to construct the lengths' list.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15123
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15124 This statement of the problem makes it elementary to write the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15125 function definition. Clearly, we will start the count at the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15126 beginning of the file, so the first command will be @code{(goto-char
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15127 (point-min))}. Next, we start the @code{while} loop; and the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15128 true-or-false test of the loop can be a regular expression search for
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15129 the next function definition---so long as the search succeeds, point
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15130 is moved forward and then the body of the loop is evaluated. The body
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15131 needs an expression that constructs the lengths' list. @code{cons},
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15132 the list construction command, can be used to create the list. That
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15133 is almost all there is to it.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15134
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15135 @need 800
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15136 Here is what this fragment of code looks like:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15137
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15138 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15139 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15140 (goto-char (point-min))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15141 (while (re-search-forward "^(defun" nil t)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15142 (setq lengths-list
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15143 (cons (count-words-in-defun) lengths-list)))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15144 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15145 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15146
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15147 What we have left out is the mechanism for finding the file that
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15148 contains the function definitions.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15149
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15150 In previous examples, we either used this, the Info file, or we
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15151 switched back and forth to some other buffer, such as the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15152 @file{*scratch*} buffer.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15153
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15154 Finding a file is a new process that we have not yet discussed.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15155
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15156 @node Find a File, lengths-list-file, Several defuns, Words in a defun
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15157 @comment node-name, next, previous, up
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15158 @section Find a File
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15159 @cindex Find a File
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15160
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15161 To find a file in Emacs, you use the @kbd{C-x C-f} (@code{find-file})
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15162 command. This command is almost, but not quite right for the lengths
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15163 problem.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15164
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15165 @need 1200
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15166 Let's look at the source for @code{find-file}:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15167
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15168 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15169 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15170 (defun find-file (filename)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15171 "Edit file FILENAME.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15172 Switch to a buffer visiting file FILENAME,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15173 creating one if none already exists."
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15174 (interactive "FFind file: ")
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15175 (switch-to-buffer (find-file-noselect filename)))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15176 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15177 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15178
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15179 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15180 (The most recent version of the @code{find-file} function definition
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15181 permits you to specify optional wildcards to visit multiple files; that
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15182 makes the definition more complex and we will not discuss it here,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15183 since it is not relevant. You can see its source using either
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15184 @kbd{M-.} (@code{find-tag}) or @kbd{C-h f} (@code{describe-function}).)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15185
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15186 @ignore
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15187 In Emacs 22
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15188 (defun find-file (filename &optional wildcards)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15189 "Edit file FILENAME.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15190 Switch to a buffer visiting file FILENAME,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15191 creating one if none already exists.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15192 Interactively, the default if you just type RET is the current directory,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15193 but the visited file name is available through the minibuffer history:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15194 type M-n to pull it into the minibuffer.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15195
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15196 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15197 expand wildcards (if any) and visit multiple files. You can
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15198 suppress wildcard expansion by setting `find-file-wildcards' to nil.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15199
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15200 To visit a file without any kind of conversion and without
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15201 automatically choosing a major mode, use \\[find-file-literally]."
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15202 (interactive (find-file-read-args "Find file: " nil))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15203 (let ((value (find-file-noselect filename nil nil wildcards)))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15204 (if (listp value)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15205 (mapcar 'switch-to-buffer (nreverse value))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15206 (switch-to-buffer value))))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15207 @end ignore
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15208
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15209 The definition I am showing possesses short but complete documentation
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15210 and an interactive specification that prompts you for a file name when
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15211 you use the command interactively. The body of the definition
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15212 contains two functions, @code{find-file-noselect} and
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15213 @code{switch-to-buffer}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15214
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15215 According to its documentation as shown by @kbd{C-h f} (the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15216 @code{describe-function} command), the @code{find-file-noselect}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15217 function reads the named file into a buffer and returns the buffer.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15218 (Its most recent version includes an optional wildcards argument,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15219 too, as well as another to read a file literally and an other you
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15220 suppress warning messages. These optional arguments are irrelevant.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15221
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15222 However, the @code{find-file-noselect} function does not select the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15223 buffer in which it puts the file. Emacs does not switch its attention
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15224 (or yours if you are using @code{find-file-noselect}) to the selected
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15225 buffer. That is what @code{switch-to-buffer} does: it switches the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15226 buffer to which Emacs attention is directed; and it switches the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15227 buffer displayed in the window to the new buffer. We have discussed
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15228 buffer switching elsewhere. (@xref{Switching Buffers}.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15229
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15230 In this histogram project, we do not need to display each file on the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15231 screen as the program determines the length of each definition within
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15232 it. Instead of employing @code{switch-to-buffer}, we can work with
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15233 @code{set-buffer}, which redirects the attention of the computer
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15234 program to a different buffer but does not redisplay it on the screen.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15235 So instead of calling on @code{find-file} to do the job, we must write
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15236 our own expression.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15237
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15238 The task is easy: use @code{find-file-noselect} and @code{set-buffer}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15239
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15240 @node lengths-list-file, Several files, Find a File, Words in a defun
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15241 @section @code{lengths-list-file} in Detail
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15242
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15243 The core of the @code{lengths-list-file} function is a @code{while}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15244 loop containing a function to move point forward `defun by defun' and
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15245 a function to count the number of words and symbols in each defun.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15246 This core must be surrounded by functions that do various other tasks,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15247 including finding the file, and ensuring that point starts out at the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15248 beginning of the file. The function definition looks like this:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15249 @findex lengths-list-file
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15250
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15251 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15252 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15253 (defun lengths-list-file (filename)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15254 "Return list of definitions' lengths within FILE.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15255 The returned list is a list of numbers.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15256 Each number is the number of words or
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15257 symbols in one function definition."
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15258 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15259 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15260 (message "Working on `%s' ... " filename)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15261 (save-excursion
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15262 (let ((buffer (find-file-noselect filename))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15263 (lengths-list))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15264 (set-buffer buffer)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15265 (setq buffer-read-only t)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15266 (widen)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15267 (goto-char (point-min))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15268 (while (re-search-forward "^(defun" nil t)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15269 (setq lengths-list
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15270 (cons (count-words-in-defun) lengths-list)))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15271 (kill-buffer buffer)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15272 lengths-list)))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15273 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15274 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15275
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15276 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15277 The function is passed one argument, the name of the file on which it
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15278 will work. It has four lines of documentation, but no interactive
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15279 specification. Since people worry that a computer is broken if they
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15280 don't see anything going on, the first line of the body is a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15281 message.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15282
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15283 The next line contains a @code{save-excursion} that returns Emacs'
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15284 attention to the current buffer when the function completes. This is
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15285 useful in case you embed this function in another function that
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15286 presumes point is restored to the original buffer.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15287
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15288 In the varlist of the @code{let} expression, Emacs finds the file and
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15289 binds the local variable @code{buffer} to the buffer containing the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15290 file. At the same time, Emacs creates @code{lengths-list} as a local
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15291 variable.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15292
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15293 Next, Emacs switches its attention to the buffer.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15294
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15295 In the following line, Emacs makes the buffer read-only. Ideally,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15296 this line is not necessary. None of the functions for counting words
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15297 and symbols in a function definition should change the buffer.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15298 Besides, the buffer is not going to be saved, even if it were changed.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15299 This line is entirely the consequence of great, perhaps excessive,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15300 caution. The reason for the caution is that this function and those
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15301 it calls work on the sources for Emacs and it is inconvenient if they
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15302 are inadvertently modified. It goes without saying that I did not
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15303 realize a need for this line until an experiment went awry and started
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15304 to modify my Emacs source files @dots{}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15305
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15306 Next comes a call to widen the buffer if it is narrowed. This
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15307 function is usually not needed---Emacs creates a fresh buffer if none
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15308 already exists; but if a buffer visiting the file already exists Emacs
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15309 returns that one. In this case, the buffer may be narrowed and must
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15310 be widened. If we wanted to be fully `user-friendly', we would
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15311 arrange to save the restriction and the location of point, but we
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15312 won't.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15313
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15314 The @code{(goto-char (point-min))} expression moves point to the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15315 beginning of the buffer.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15316
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15317 Then comes a @code{while} loop in which the `work' of the function is
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15318 carried out. In the loop, Emacs determines the length of each
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15319 definition and constructs a lengths' list containing the information.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15320
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15321 Emacs kills the buffer after working through it. This is to save
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15322 space inside of Emacs. My version of GNU Emacs 19 contained over 300
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15323 source files of interest; GNU Emacs 22 contains over a thousand source
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15324 files. Another function will apply @code{lengths-list-file} to each
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15325 of the files.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15326
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15327 Finally, the last expression within the @code{let} expression is the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15328 @code{lengths-list} variable; its value is returned as the value of
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15329 the whole function.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15330
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15331 You can try this function by installing it in the usual fashion. Then
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15332 place your cursor after the following expression and type @kbd{C-x
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15333 C-e} (@code{eval-last-sexp}).
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15334
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15335 @c !!! 22.1.1 lisp sources location here
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15336 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15337 (lengths-list-file
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15338 "/usr/local/share/emacs/22.1.1/lisp/emacs-lisp/debug.el")
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15339 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15340
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15341 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15342 (You may need to change the pathname of the file; the one here is for
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15343 GNU Emacs version 22.1.1. To change the expression, copy it to
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15344 the @file{*scratch*} buffer and edit it.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15345
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15346 @need 1200
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15347 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15348 (Also, to see the full length of the list, rather than a truncated
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15349 version, you may have to evaluate the following:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15350
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15351 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15352 (custom-set-variables '(eval-expression-print-length nil))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15353 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15354
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15355 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15356 (@xref{defcustom, , Specifying Variables using @code{defcustom}}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15357 Then evaluate the @code{lengths-list-file} expression.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15358
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15359 @need 1200
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15360 The lengths' list for @file{debug.el} takes less than a second to
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15361 produce and looks like this in GNU Emacs 22:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15362
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15363 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15364 (83 113 105 144 289 22 30 97 48 89 25 52 52 88 28 29 77 49 43 290 232 587)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15365 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15366
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15367 @need 1500
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15368 (Using my old machine, the version 19 lengths' list for @file{debug.el}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15369 took seven seconds to produce and looked like this:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15370
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15371 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15372 (75 41 80 62 20 45 44 68 45 12 34 235)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15373 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15374
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15375 (The newer version of @file{debug.el} contains more defuns than the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15376 earlier one; and my new machine is much faster than the old one.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15377
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15378 Note that the length of the last definition in the file is first in
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15379 the list.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15380
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15381 @node Several files, Several files recursively, lengths-list-file, Words in a defun
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15382 @section Count Words in @code{defuns} in Different Files
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15383
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15384 In the previous section, we created a function that returns a list of
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15385 the lengths of each definition in a file. Now, we want to define a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15386 function to return a master list of the lengths of the definitions in
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15387 a list of files.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15388
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15389 Working on each of a list of files is a repetitious act, so we can use
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15390 either a @code{while} loop or recursion.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15391
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15392 @menu
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15393 * lengths-list-many-files:: Return a list of the lengths of defuns.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15394 * append:: Attach one list to another.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15395 @end menu
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15396
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15397 @node lengths-list-many-files, append, Several files, Several files
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15398 @ifnottex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15399 @unnumberedsubsec Determine the lengths of @code{defuns}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15400 @end ifnottex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15401
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15402 The design using a @code{while} loop is routine. The argument passed
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15403 the function is a list of files. As we saw earlier (@pxref{Loop
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15404 Example}), you can write a @code{while} loop so that the body of the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15405 loop is evaluated if such a list contains elements, but to exit the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15406 loop if the list is empty. For this design to work, the body of the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15407 loop must contain an expression that shortens the list each time the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15408 body is evaluated, so that eventually the list is empty. The usual
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15409 technique is to set the value of the list to the value of the @sc{cdr}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15410 of the list each time the body is evaluated.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15411
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15412 @need 800
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15413 The template looks like this:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15414
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15415 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15416 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15417 (while @var{test-whether-list-is-empty}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15418 @var{body}@dots{}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15419 @var{set-list-to-cdr-of-list})
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15420 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15421 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15422
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15423 Also, we remember that a @code{while} loop returns @code{nil} (the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15424 result of evaluating the true-or-false-test), not the result of any
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15425 evaluation within its body. (The evaluations within the body of the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15426 loop are done for their side effects.) However, the expression that
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15427 sets the lengths' list is part of the body---and that is the value
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15428 that we want returned by the function as a whole. To do this, we
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15429 enclose the @code{while} loop within a @code{let} expression, and
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15430 arrange that the last element of the @code{let} expression contains
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15431 the value of the lengths' list. (@xref{Incrementing Example, , Loop
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15432 Example with an Incrementing Counter}.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15433
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15434 @findex lengths-list-many-files
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15435 @need 1250
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15436 These considerations lead us directly to the function itself:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15437
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15438 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15439 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15440 ;;; @r{Use @code{while} loop.}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15441 (defun lengths-list-many-files (list-of-files)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15442 "Return list of lengths of defuns in LIST-OF-FILES."
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15443 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15444 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15445 (let (lengths-list)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15446
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15447 ;;; @r{true-or-false-test}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15448 (while list-of-files
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15449 (setq lengths-list
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15450 (append
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15451 lengths-list
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15452
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15453 ;;; @r{Generate a lengths' list.}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15454 (lengths-list-file
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15455 (expand-file-name (car list-of-files)))))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15456 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15457
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15458 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15459 ;;; @r{Make files' list shorter.}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15460 (setq list-of-files (cdr list-of-files)))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15461
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15462 ;;; @r{Return final value of lengths' list.}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15463 lengths-list))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15464 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15465 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15466
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15467 @code{expand-file-name} is a built-in function that converts a file
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15468 name to the absolute, long, path name form. The function employs the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15469 name of the directory in which the function is called.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15470
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15471 @c !!! 22.1.1 lisp sources location here
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15472 @need 1500
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15473 Thus, if @code{expand-file-name} is called on @code{debug.el} when
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15474 Emacs is visiting the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15475 @file{/usr/local/share/emacs/22.1.1/lisp/emacs-lisp/} directory,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15476
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15477 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15478 debug.el
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15479 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15480
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15481 @need 800
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15482 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15483 becomes
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15484
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15485 @c !!! 22.1.1 lisp sources location here
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15486 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15487 /usr/local/share/emacs/22.1.1/lisp/emacs-lisp/debug.el
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15488 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15489
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15490 The only other new element of this function definition is the as yet
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15491 unstudied function @code{append}, which merits a short section for
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15492 itself.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15493
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15494 @node append, , lengths-list-many-files, Several files
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15495 @subsection The @code{append} Function
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15496
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15497 @need 800
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15498 The @code{append} function attaches one list to another. Thus,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15499
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15500 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15501 (append '(1 2 3 4) '(5 6 7 8))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15502 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15503
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15504 @need 800
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15505 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15506 produces the list
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15507
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15508 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15509 (1 2 3 4 5 6 7 8)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15510 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15511
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15512 This is exactly how we want to attach two lengths' lists produced by
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15513 @code{lengths-list-file} to each other. The results contrast with
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15514 @code{cons},
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15515
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15516 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15517 (cons '(1 2 3 4) '(5 6 7 8))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15518 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15519
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15520 @need 1250
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15521 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15522 which constructs a new list in which the first argument to @code{cons}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15523 becomes the first element of the new list:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15524
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15525 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15526 ((1 2 3 4) 5 6 7 8)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15527 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15528
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15529 @node Several files recursively, Prepare the data, Several files, Words in a defun
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15530 @section Recursively Count Words in Different Files
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15531
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15532 Besides a @code{while} loop, you can work on each of a list of files
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15533 with recursion. A recursive version of @code{lengths-list-many-files}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15534 is short and simple.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15535
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15536 The recursive function has the usual parts: the `do-again-test', the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15537 `next-step-expression', and the recursive call. The `do-again-test'
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15538 determines whether the function should call itself again, which it
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15539 will do if the @code{list-of-files} contains any remaining elements;
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15540 the `next-step-expression' resets the @code{list-of-files} to the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15541 @sc{cdr} of itself, so eventually the list will be empty; and the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15542 recursive call calls itself on the shorter list. The complete
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15543 function is shorter than this description!
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15544 @findex recursive-lengths-list-many-files
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15545
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15546 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15547 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15548 (defun recursive-lengths-list-many-files (list-of-files)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15549 "Return list of lengths of each defun in LIST-OF-FILES."
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15550 (if list-of-files ; @r{do-again-test}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15551 (append
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15552 (lengths-list-file
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15553 (expand-file-name (car list-of-files)))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15554 (recursive-lengths-list-many-files
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15555 (cdr list-of-files)))))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15556 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15557 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15558
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15559 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15560 In a sentence, the function returns the lengths' list for the first of
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15561 the @code{list-of-files} appended to the result of calling itself on
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15562 the rest of the @code{list-of-files}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15563
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15564 Here is a test of @code{recursive-lengths-list-many-files}, along with
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15565 the results of running @code{lengths-list-file} on each of the files
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15566 individually.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15567
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15568 Install @code{recursive-lengths-list-many-files} and
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15569 @code{lengths-list-file}, if necessary, and then evaluate the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15570 following expressions. You may need to change the files' pathnames;
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15571 those here work when this Info file and the Emacs sources are located
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15572 in their customary places. To change the expressions, copy them to
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15573 the @file{*scratch*} buffer, edit them, and then evaluate them.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15574
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15575 The results are shown after the @samp{@result{}}. (These results are
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15576 for files from Emacs version 22.1.1; files from other versions of
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15577 Emacs may produce different results.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15578
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15579 @c !!! 22.1.1 lisp sources location here
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15580 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15581 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15582 (cd "/usr/local/share/emacs/22.1.1/")
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15583
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15584 (lengths-list-file "./lisp/macros.el")
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15585 @result{} (283 263 480 90)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15586 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15587
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15588 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15589 (lengths-list-file "./lisp/mail/mailalias.el")
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15590 @result{} (38 32 29 95 178 180 321 218 324)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15591 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15592
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15593 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15594 (lengths-list-file "./lisp/makesum.el")
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15595 @result{} (85 181)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15596 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15597
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15598 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15599 (recursive-lengths-list-many-files
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15600 '("./lisp/macros.el"
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15601 "./lisp/mail/mailalias.el"
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15602 "./lisp/makesum.el"))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15603 @result{} (283 263 480 90 38 32 29 95 178 180 321 218 324 85 181)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15604 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15605 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15606
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15607 The @code{recursive-lengths-list-many-files} function produces the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15608 output we want.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15609
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15610 The next step is to prepare the data in the list for display in a graph.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15611
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15612 @node Prepare the data, , Several files recursively, Words in a defun
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15613 @section Prepare the Data for Display in a Graph
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15614
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15615 The @code{recursive-lengths-list-many-files} function returns a list
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15616 of numbers. Each number records the length of a function definition.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15617 What we need to do now is transform this data into a list of numbers
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15618 suitable for generating a graph. The new list will tell how many
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15619 functions definitions contain less than 10 words and
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15620 symbols, how many contain between 10 and 19 words and symbols, how
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15621 many contain between 20 and 29 words and symbols, and so on.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15622
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15623 In brief, we need to go through the lengths' list produced by the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15624 @code{recursive-lengths-list-many-files} function and count the number
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15625 of defuns within each range of lengths, and produce a list of those
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15626 numbers.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15627
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15628 @menu
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15629 * Data for Display in Detail::
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15630 * Sorting:: Sorting lists.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15631 * Files List:: Making a list of files.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15632 * Counting function definitions::
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15633 @end menu
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15634
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15635 @node Data for Display in Detail, Sorting, Prepare the data, Prepare the data
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15636 @ifnottex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15637 @unnumberedsubsec The Data for Display in Detail
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15638 @end ifnottex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15639
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15640 Based on what we have done before, we can readily foresee that it
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15641 should not be too hard to write a function that `@sc{cdr}s' down the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15642 lengths' list, looks at each element, determines which length range it
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15643 is in, and increments a counter for that range.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15644
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15645 However, before beginning to write such a function, we should consider
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15646 the advantages of sorting the lengths' list first, so the numbers are
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15647 ordered from smallest to largest. First, sorting will make it easier
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15648 to count the numbers in each range, since two adjacent numbers will
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15649 either be in the same length range or in adjacent ranges. Second, by
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15650 inspecting a sorted list, we can discover the highest and lowest
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15651 number, and thereby determine the largest and smallest length range
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15652 that we will need.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15653
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15654 @node Sorting, Files List, Data for Display in Detail, Prepare the data
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15655 @subsection Sorting Lists
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15656 @findex sort
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15657
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15658 Emacs contains a function to sort lists, called (as you might guess)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15659 @code{sort}. The @code{sort} function takes two arguments, the list
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15660 to be sorted, and a predicate that determines whether the first of
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15661 two list elements is ``less'' than the second.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15662
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15663 As we saw earlier (@pxref{Wrong Type of Argument, , Using the Wrong
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15664 Type Object as an Argument}), a predicate is a function that
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15665 determines whether some property is true or false. The @code{sort}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15666 function will reorder a list according to whatever property the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15667 predicate uses; this means that @code{sort} can be used to sort
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15668 non-numeric lists by non-numeric criteria---it can, for example,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15669 alphabetize a list.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15670
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15671 @need 1250
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15672 The @code{<} function is used when sorting a numeric list. For example,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15673
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15674 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15675 (sort '(4 8 21 17 33 7 21 7) '<)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15676 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15677
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15678 @need 800
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15679 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15680 produces this:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15681
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15682 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15683 (4 7 7 8 17 21 21 33)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15684 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15685
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15686 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15687 (Note that in this example, both the arguments are quoted so that the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15688 symbols are not evaluated before being passed to @code{sort} as
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15689 arguments.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15690
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15691 Sorting the list returned by the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15692 @code{recursive-lengths-list-many-files} function is straightforward;
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15693 it uses the @code{<} function:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15694
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15695 @ignore
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15696 2006 Oct 29
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15697 In GNU Emacs 22, eval
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15698 (progn
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15699 (cd "/usr/local/share/emacs/22.0.50/")
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15700 (sort
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15701 (recursive-lengths-list-many-files
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15702 '("./lisp/macros.el"
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15703 "./lisp/mail/mailalias.el"
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15704 "./lisp/makesum.el"))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15705 '<))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15706
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15707 @end ignore
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15708
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15709 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15710 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15711 (sort
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15712 (recursive-lengths-list-many-files
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15713 '("./lisp/macros.el"
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15714 "./lisp/mailalias.el"
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15715 "./lisp/makesum.el"))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15716 '<)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15717 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15718 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15719
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15720 @need 800
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15721 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15722 which produces:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15723
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15724 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15725 (29 32 38 85 90 95 178 180 181 218 263 283 321 324 480)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15726 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15727
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15728 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15729 (Note that in this example, the first argument to @code{sort} is not
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15730 quoted, since the expression must be evaluated so as to produce the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15731 list that is passed to @code{sort}.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15732
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15733 @node Files List, Counting function definitions, Sorting, Prepare the data
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15734 @subsection Making a List of Files
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15735
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15736 The @code{recursive-lengths-list-many-files} function requires a list
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15737 of files as its argument. For our test examples, we constructed such
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15738 a list by hand; but the Emacs Lisp source directory is too large for
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15739 us to do for that. Instead, we will write a function to do the job
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15740 for us. In this function, we will use both a @code{while} loop and a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15741 recursive call.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15742
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15743 @findex directory-files
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15744 We did not have to write a function like this for older versions of
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15745 GNU Emacs, since they placed all the @samp{.el} files in one
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15746 directory. Instead, we were able to use the @code{directory-files}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15747 function, which lists the names of files that match a specified
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15748 pattern within a single directory.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15749
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15750 However, recent versions of Emacs place Emacs Lisp files in
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15751 sub-directories of the top level @file{lisp} directory. This
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15752 re-arrangement eases navigation. For example, all the mail related
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15753 files are in a @file{lisp} sub-directory called @file{mail}. But at
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15754 the same time, this arrangement forces us to create a file listing
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15755 function that descends into the sub-directories.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15756
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15757 @findex files-in-below-directory
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15758 We can create this function, called @code{files-in-below-directory},
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15759 using familiar functions such as @code{car}, @code{nthcdr}, and
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15760 @code{substring} in conjunction with an existing function called
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15761 @code{directory-files-and-attributes}. This latter function not only
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15762 lists all the filenames in a directory, including the names
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15763 of sub-directories, but also their attributes.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15764
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15765 To restate our goal: to create a function that will enable us
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15766 to feed filenames to @code{recursive-lengths-list-many-files}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15767 as a list that looks like this (but with more elements):
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15768
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15769 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15770 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15771 ("./lisp/macros.el"
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15772 "./lisp/mail/rmail.el"
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15773 "./lisp/makesum.el")
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15774 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15775 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15776
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15777 The @code{directory-files-and-attributes} function returns a list of
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15778 lists. Each of the lists within the main list consists of 13
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15779 elements. The first element is a string that contains the name of the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15780 file -- which, in GNU/Linux, may be a `directory file', that is to
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15781 say, a file with the special attributes of a directory. The second
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15782 element of the list is @code{t} for a directory, a string
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15783 for symbolic link (the string is the name linked to), or @code{nil}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15784
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15785 For example, the first @samp{.el} file in the @file{lisp/} directory
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15786 is @file{abbrev.el}. Its name is
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15787 @file{/usr/local/share/emacs/22.1.1/lisp/abbrev.el} and it is not a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15788 directory or a symbolic link.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15789
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15790 @need 1000
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15791 This is how @code{directory-files-and-attributes} lists that file and
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15792 its attributes:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15793
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15794 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15795 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15796 ("abbrev.el"
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15797 nil
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15798 1
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15799 1000
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15800 100
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15801 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15802 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15803 (17733 259)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15804 (17491 28834)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15805 (17596 62124)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15806 13157
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15807 "-rw-rw-r--"
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15808 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15809 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15810 nil
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15811 2971624
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15812 773)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15813 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15814 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15815
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15816 @need 1200
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15817 On the other hand, @file{mail/} is a directory within the @file{lisp/}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15818 directory. The beginning of its listing looks like this:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15819
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15820 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15821 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15822 ("mail"
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15823 t
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15824 @dots{}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15825 )
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15826 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15827 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15828
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15829 (To learn about the different attributes, look at the documentation of
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15830 @code{file-attributes}. Bear in mind that the @code{file-attributes}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15831 function does not list the filename, so its first element is
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15832 @code{directory-files-and-attributes}'s second element.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15833
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15834 We will want our new function, @code{files-in-below-directory}, to
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15835 list the @samp{.el} files in the directory it is told to check, and in
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15836 any directories below that directory.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15837
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15838 This gives us a hint on how to construct
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15839 @code{files-in-below-directory}: within a directory, the function
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15840 should add @samp{.el} filenames to a list; and if, within a directory,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15841 the function comes upon a sub-directory, it should go into that
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15842 sub-directory and repeat its actions.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15843
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15844 However, we should note that every directory contains a name that
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15845 refers to itself, called @file{.}, (``dot'') and a name that refers to
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15846 its parent directory, called @file{..} (``double dot''). (In
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15847 @file{/}, the root directory, @file{..} refers to itself, since
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15848 @file{/} has no parent.) Clearly, we do not want our
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15849 @code{files-in-below-directory} function to enter those directories,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15850 since they always lead us, directly or indirectly, to the current
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15851 directory.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15852
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15853 Consequently, our @code{files-in-below-directory} function must do
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15854 several tasks:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15855
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15856 @itemize @bullet
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15857 @item
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15858 Check to see whether it is looking at a filename that ends in
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15859 @samp{.el}; and if so, add its name to a list.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15860
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15861 @item
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15862 Check to see whether it is looking at a filename that is the name of a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15863 directory; and if so,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15864
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15865 @itemize @minus
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15866 @item
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15867 Check to see whether it is looking at @file{.} or @file{..}; and if
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15868 so skip it.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15869
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15870 @item
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15871 Or else, go into that directory and repeat the process.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15872 @end itemize
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15873 @end itemize
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15874
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15875 Let's write a function definition to do these tasks. We will use a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15876 @code{while} loop to move from one filename to another within a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15877 directory, checking what needs to be done; and we will use a recursive
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15878 call to repeat the actions on each sub-directory. The recursive
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15879 pattern is `accumulate'
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15880 (@pxref{Accumulate, , Recursive Pattern: @emph{accumulate}}),
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15881 using @code{append} as the combiner.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15882
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15883 @ignore
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15884 (directory-files "/usr/local/src/emacs/lisp/" t "\\.el$")
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15885 (shell-command "find /usr/local/src/emacs/lisp/ -name '*.el'")
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15886
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15887 (directory-files "/usr/local/share/emacs/22.1.1/lisp/" t "\\.el$")
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15888 (shell-command "find /usr/local/share/emacs/22.1.1/lisp/ -name '*.el'")
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15889 @end ignore
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15890
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15891 @c /usr/local/share/emacs/22.1.1/lisp/
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15892
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15893 @need 800
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15894 Here is the function:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15895
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15896 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15897 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15898 (defun files-in-below-directory (directory)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15899 "List the .el files in DIRECTORY and in its sub-directories."
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15900 ;; Although the function will be used non-interactively,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15901 ;; it will be easier to test if we make it interactive.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15902 ;; The directory will have a name such as
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15903 ;; "/usr/local/share/emacs/22.1.1/lisp/"
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15904 (interactive "DDirectory name: ")
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15905 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15906 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15907 (let (el-files-list
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15908 (current-directory-list
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15909 (directory-files-and-attributes directory t)))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15910 ;; while we are in the current directory
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15911 (while current-directory-list
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15912 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15913 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15914 (cond
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15915 ;; check to see whether filename ends in `.el'
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15916 ;; and if so, append its name to a list.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15917 ((equal ".el" (substring (car (car current-directory-list)) -3))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15918 (setq el-files-list
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15919 (cons (car (car current-directory-list)) el-files-list)))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15920 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15921 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15922 ;; check whether filename is that of a directory
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15923 ((eq t (car (cdr (car current-directory-list))))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15924 ;; decide whether to skip or recurse
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15925 (if
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15926 (equal "."
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15927 (substring (car (car current-directory-list)) -1))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15928 ;; then do nothing since filename is that of
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15929 ;; current directory or parent, "." or ".."
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15930 ()
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15931 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15932 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15933 ;; else descend into the directory and repeat the process
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15934 (setq el-files-list
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15935 (append
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15936 (files-in-below-directory
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15937 (car (car current-directory-list)))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15938 el-files-list)))))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15939 ;; move to the next filename in the list; this also
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15940 ;; shortens the list so the while loop eventually comes to an end
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15941 (setq current-directory-list (cdr current-directory-list)))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15942 ;; return the filenames
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15943 el-files-list))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15944 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15945 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15946
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15947 @c (files-in-below-directory "/usr/local/src/emacs/lisp/")
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15948 @c (files-in-below-directory "/usr/local/share/emacs/22.1.1/lisp/")
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15949
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15950 The @code{files-in-below-directory} @code{directory-files} function
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15951 takes one argument, the name of a directory.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15952
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15953 @need 1250
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15954 Thus, on my system,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15955
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15956 @c (length (files-in-below-directory "/usr/local/src/emacs/lisp/"))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15957
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15958 @c !!! 22.1.1 lisp sources location here
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15959 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15960 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15961 (length
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15962 (files-in-below-directory "/usr/local/share/emacs/22.1.1/lisp/"))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15963 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15964 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15965
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15966 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15967 tells me that in and below my Lisp sources directory are 1031
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15968 @samp{.el} files.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15969
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15970 @code{files-in-below-directory} returns a list in reverse alphabetical
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15971 order. An expression to sort the list in alphabetical order looks
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15972 like this:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15973
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15974 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15975 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15976 (sort
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15977 (files-in-below-directory "/usr/local/share/emacs/22.1.1/lisp/")
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15978 'string-lessp)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15979 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15980 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15981
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15982 @ignore
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15983 (defun test ()
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15984 "Test how long it takes to find lengths of all sorted elisp defuns."
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15985 (insert "\n" (current-time-string) "\n")
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15986 (sit-for 0)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15987 (sort
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15988 (recursive-lengths-list-many-files
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15989 (files-in-below-directory "/usr/local/src/emacs/lisp/"))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15990 '<)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15991 (insert (format "%s" (current-time-string))))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15992 @end ignore
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15993
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15994 @node Counting function definitions, , Files List, Prepare the data
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15995 @subsection Counting function definitions
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15996
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15997 Our immediate goal is to generate a list that tells us how many
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15998 function definitions contain fewer than 10 words and symbols, how many
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15999 contain between 10 and 19 words and symbols, how many contain between
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16000 20 and 29 words and symbols, and so on.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16001
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16002 With a sorted list of numbers, this is easy: count how many elements
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16003 of the list are smaller than 10, then, after moving past the numbers
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16004 just counted, count how many are smaller than 20, then, after moving
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16005 past the numbers just counted, count how many are smaller than 30, and
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16006 so on. Each of the numbers, 10, 20, 30, 40, and the like, is one
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16007 larger than the top of that range. We can call the list of such
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16008 numbers the @code{top-of-ranges} list.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16009
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16010 @need 1200
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16011 If we wished, we could generate this list automatically, but it is
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16012 simpler to write a list manually. Here it is:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16013 @vindex top-of-ranges
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16014
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16015 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16016 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16017 (defvar top-of-ranges
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16018 '(10 20 30 40 50
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16019 60 70 80 90 100
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16020 110 120 130 140 150
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16021 160 170 180 190 200
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16022 210 220 230 240 250
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16023 260 270 280 290 300)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16024 "List specifying ranges for `defuns-per-range'.")
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16025 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16026 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16027
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16028 To change the ranges, we edit this list.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16029
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16030 Next, we need to write the function that creates the list of the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16031 number of definitions within each range. Clearly, this function must
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16032 take the @code{sorted-lengths} and the @code{top-of-ranges} lists
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16033 as arguments.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16034
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16035 The @code{defuns-per-range} function must do two things again and
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16036 again: it must count the number of definitions within a range
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16037 specified by the current top-of-range value; and it must shift to the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16038 next higher value in the @code{top-of-ranges} list after counting the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16039 number of definitions in the current range. Since each of these
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16040 actions is repetitive, we can use @code{while} loops for the job.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16041 One loop counts the number of definitions in the range defined by the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16042 current top-of-range value, and the other loop selects each of the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16043 top-of-range values in turn.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16044
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16045 Several entries of the @code{sorted-lengths} list are counted for each
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16046 range; this means that the loop for the @code{sorted-lengths} list
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16047 will be inside the loop for the @code{top-of-ranges} list, like a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16048 small gear inside a big gear.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16049
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16050 The inner loop counts the number of definitions within the range. It
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16051 is a simple counting loop of the type we have seen before.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16052 (@xref{Incrementing Loop, , A loop with an incrementing counter}.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16053 The true-or-false test of the loop tests whether the value from the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16054 @code{sorted-lengths} list is smaller than the current value of the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16055 top of the range. If it is, the function increments the counter and
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16056 tests the next value from the @code{sorted-lengths} list.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16057
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16058 @need 1250
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16059 The inner loop looks like this:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16060
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16061 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16062 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16063 (while @var{length-element-smaller-than-top-of-range}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16064 (setq number-within-range (1+ number-within-range))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16065 (setq sorted-lengths (cdr sorted-lengths)))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16066 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16067 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16068
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16069 The outer loop must start with the lowest value of the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16070 @code{top-of-ranges} list, and then be set to each of the succeeding
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16071 higher values in turn. This can be done with a loop like this:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16072
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16073 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16074 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16075 (while top-of-ranges
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16076 @var{body-of-loop}@dots{}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16077 (setq top-of-ranges (cdr top-of-ranges)))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16078 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16079 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16080
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16081 @need 1200
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16082 Put together, the two loops look like this:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16083
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16084 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16085 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16086 (while top-of-ranges
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16087
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16088 ;; @r{Count the number of elements within the current range.}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16089 (while @var{length-element-smaller-than-top-of-range}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16090 (setq number-within-range (1+ number-within-range))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16091 (setq sorted-lengths (cdr sorted-lengths)))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16092
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16093 ;; @r{Move to next range.}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16094 (setq top-of-ranges (cdr top-of-ranges)))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16095 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16096 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16097
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16098 In addition, in each circuit of the outer loop, Emacs should record
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16099 the number of definitions within that range (the value of
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16100 @code{number-within-range}) in a list. We can use @code{cons} for
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16101 this purpose. (@xref{cons, , @code{cons}}.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16102
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16103 The @code{cons} function works fine, except that the list it
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16104 constructs will contain the number of definitions for the highest
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16105 range at its beginning and the number of definitions for the lowest
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16106 range at its end. This is because @code{cons} attaches new elements
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16107 of the list to the beginning of the list, and since the two loops are
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16108 working their way through the lengths' list from the lower end first,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16109 the @code{defuns-per-range-list} will end up largest number first.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16110 But we will want to print our graph with smallest values first and the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16111 larger later. The solution is to reverse the order of the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16112 @code{defuns-per-range-list}. We can do this using the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16113 @code{nreverse} function, which reverses the order of a list.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16114 @findex nreverse
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16115
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16116 @need 800
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16117 For example,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16118
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16119 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16120 (nreverse '(1 2 3 4))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16121 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16122
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16123 @need 800
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16124 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16125 produces:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16126
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16127 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16128 (4 3 2 1)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16129 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16130
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16131 Note that the @code{nreverse} function is ``destructive''---that is,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16132 it changes the list to which it is applied; this contrasts with the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16133 @code{car} and @code{cdr} functions, which are non-destructive. In
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16134 this case, we do not want the original @code{defuns-per-range-list},
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16135 so it does not matter that it is destroyed. (The @code{reverse}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16136 function provides a reversed copy of a list, leaving the original list
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16137 as is.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16138 @findex reverse
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16139
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16140 @need 1250
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16141 Put all together, the @code{defuns-per-range} looks like this:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16142
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16143 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16144 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16145 (defun defuns-per-range (sorted-lengths top-of-ranges)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16146 "SORTED-LENGTHS defuns in each TOP-OF-RANGES range."
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16147 (let ((top-of-range (car top-of-ranges))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16148 (number-within-range 0)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16149 defuns-per-range-list)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16150 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16151
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16152 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16153 ;; @r{Outer loop.}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16154 (while top-of-ranges
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16155 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16156
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16157 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16158 ;; @r{Inner loop.}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16159 (while (and
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16160 ;; @r{Need number for numeric test.}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16161 (car sorted-lengths)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16162 (< (car sorted-lengths) top-of-range))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16163 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16164
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16165 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16166 ;; @r{Count number of definitions within current range.}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16167 (setq number-within-range (1+ number-within-range))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16168 (setq sorted-lengths (cdr sorted-lengths)))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16169
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16170 ;; @r{Exit inner loop but remain within outer loop.}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16171 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16172
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16173 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16174 (setq defuns-per-range-list
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16175 (cons number-within-range defuns-per-range-list))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16176 (setq number-within-range 0) ; @r{Reset count to zero.}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16177 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16178
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16179 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16180 ;; @r{Move to next range.}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16181 (setq top-of-ranges (cdr top-of-ranges))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16182 ;; @r{Specify next top of range value.}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16183 (setq top-of-range (car top-of-ranges)))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16184 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16185
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16186 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16187 ;; @r{Exit outer loop and count the number of defuns larger than}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16188 ;; @r{ the largest top-of-range value.}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16189 (setq defuns-per-range-list
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16190 (cons
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16191 (length sorted-lengths)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16192 defuns-per-range-list))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16193 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16194
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16195 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16196 ;; @r{Return a list of the number of definitions within each range,}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16197 ;; @r{ smallest to largest.}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16198 (nreverse defuns-per-range-list)))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16199 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16200 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16201
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16202 @need 1200
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16203 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16204 The function is straightforward except for one subtle feature. The
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16205 true-or-false test of the inner loop looks like this:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16206
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16207 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16208 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16209 (and (car sorted-lengths)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16210 (< (car sorted-lengths) top-of-range))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16211 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16212 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16213
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16214 @need 800
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16215 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16216 instead of like this:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16217
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16218 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16219 (< (car sorted-lengths) top-of-range)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16220 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16221
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16222 The purpose of the test is to determine whether the first item in the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16223 @code{sorted-lengths} list is less than the value of the top of the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16224 range.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16225
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16226 The simple version of the test works fine unless the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16227 @code{sorted-lengths} list has a @code{nil} value. In that case, the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16228 @code{(car sorted-lengths)} expression function returns
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16229 @code{nil}. The @code{<} function cannot compare a number to
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16230 @code{nil}, which is an empty list, so Emacs signals an error and
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16231 stops the function from attempting to continue to execute.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16232
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16233 The @code{sorted-lengths} list always becomes @code{nil} when the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16234 counter reaches the end of the list. This means that any attempt to
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16235 use the @code{defuns-per-range} function with the simple version of
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16236 the test will fail.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16237
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16238 We solve the problem by using the @code{(car sorted-lengths)}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16239 expression in conjunction with the @code{and} expression. The
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16240 @code{(car sorted-lengths)} expression returns a non-@code{nil}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16241 value so long as the list has at least one number within it, but
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16242 returns @code{nil} if the list is empty. The @code{and} expression
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16243 first evaluates the @code{(car sorted-lengths)} expression, and
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16244 if it is @code{nil}, returns false @emph{without} evaluating the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16245 @code{<} expression. But if the @code{(car sorted-lengths)}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16246 expression returns a non-@code{nil} value, the @code{and} expression
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16247 evaluates the @code{<} expression, and returns that value as the value
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16248 of the @code{and} expression.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16249
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16250 @c colon in printed section title causes problem in Info cross reference
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16251 This way, we avoid an error.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16252 @iftex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16253 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16254 (For information about @code{and}, see
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16255 @ref{kill-new function, , The @code{kill-new} function}.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16256 @end iftex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16257 @ifinfo
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16258 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16259 (@xref{kill-new function, , The @code{kill-new} function}, for
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16260 information about @code{and}.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16261 @end ifinfo
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16262
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16263 Here is a short test of the @code{defuns-per-range} function. First,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16264 evaluate the expression that binds (a shortened)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16265 @code{top-of-ranges} list to the list of values, then evaluate the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16266 expression for binding the @code{sorted-lengths} list, and then
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16267 evaluate the @code{defuns-per-range} function.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16268
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16269 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16270 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16271 ;; @r{(Shorter list than we will use later.)}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16272 (setq top-of-ranges
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16273 '(110 120 130 140 150
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16274 160 170 180 190 200))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16275
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16276 (setq sorted-lengths
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16277 '(85 86 110 116 122 129 154 176 179 200 265 300 300))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16278
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16279 (defuns-per-range sorted-lengths top-of-ranges)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16280 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16281 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16282
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16283 @need 800
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16284 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16285 The list returned looks like this:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16286
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16287 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16288 (2 2 2 0 0 1 0 2 0 0 4)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16289 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16290
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16291 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16292 Indeed, there are two elements of the @code{sorted-lengths} list
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16293 smaller than 110, two elements between 110 and 119, two elements
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16294 between 120 and 129, and so on. There are four elements with a value
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16295 of 200 or larger.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16296
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16297 @c The next step is to turn this numbers' list into a graph.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16298 @node Readying a Graph, Emacs Initialization, Words in a defun, Top
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16299 @chapter Readying a Graph
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16300 @cindex Readying a graph
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16301 @cindex Graph prototype
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16302 @cindex Prototype graph
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16303 @cindex Body of graph
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16304
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16305 Our goal is to construct a graph showing the numbers of function
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16306 definitions of various lengths in the Emacs lisp sources.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16307
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16308 As a practical matter, if you were creating a graph, you would
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16309 probably use a program such as @code{gnuplot} to do the job.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16310 (@code{gnuplot} is nicely integrated into GNU Emacs.) In this case,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16311 however, we create one from scratch, and in the process we will
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16312 re-acquaint ourselves with some of what we learned before and learn
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16313 more.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16314
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16315 In this chapter, we will first write a simple graph printing function.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16316 This first definition will be a @dfn{prototype}, a rapidly written
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16317 function that enables us to reconnoiter this unknown graph-making
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16318 territory. We will discover dragons, or find that they are myth.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16319 After scouting the terrain, we will feel more confident and enhance
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16320 the function to label the axes automatically.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16321
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16322 @menu
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16323 * Columns of a graph::
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16324 * graph-body-print:: How to print the body of a graph.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16325 * recursive-graph-body-print::
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16326 * Printed Axes::
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16327 * Line Graph Exercise::
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16328 @end menu
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16329
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16330 @node Columns of a graph, graph-body-print, Readying a Graph, Readying a Graph
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16331 @ifnottex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16332 @unnumberedsec Printing the Columns of a Graph
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16333 @end ifnottex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16334
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16335 Since Emacs is designed to be flexible and work with all kinds of
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16336 terminals, including character-only terminals, the graph will need to
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16337 be made from one of the `typewriter' symbols. An asterisk will do; as
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16338 we enhance the graph-printing function, we can make the choice of
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16339 symbol a user option.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16340
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16341 We can call this function @code{graph-body-print}; it will take a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16342 @code{numbers-list} as its only argument. At this stage, we will not
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16343 label the graph, but only print its body.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16344
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16345 The @code{graph-body-print} function inserts a vertical column of
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16346 asterisks for each element in the @code{numbers-list}. The height of
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16347 each line is determined by the value of that element of the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16348 @code{numbers-list}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16349
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16350 Inserting columns is a repetitive act; that means that this function can
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16351 be written either with a @code{while} loop or recursively.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16352
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16353 Our first challenge is to discover how to print a column of asterisks.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16354 Usually, in Emacs, we print characters onto a screen horizontally,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16355 line by line, by typing. We have two routes we can follow: write our
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16356 own column-insertion function or discover whether one exists in Emacs.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16357
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16358 To see whether there is one in Emacs, we can use the @kbd{M-x apropos}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16359 command. This command is like the @kbd{C-h a} (@code{command-apropos})
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16360 command, except that the latter finds only those functions that are
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16361 commands. The @kbd{M-x apropos} command lists all symbols that match
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16362 a regular expression, including functions that are not interactive.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16363 @findex apropos
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16364
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16365 What we want to look for is some command that prints or inserts
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16366 columns. Very likely, the name of the function will contain either
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16367 the word `print' or the word `insert' or the word `column'.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16368 Therefore, we can simply type @kbd{M-x apropos RET
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16369 print\|insert\|column RET} and look at the result. On my system, this
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16370 command once too takes quite some time, and then produced a list of 79
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16371 functions and variables. Now it does not take much time at all and
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16372 produces a list of 211 functions and variables. Scanning down the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16373 list, the only function that looks as if it might do the job is
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16374 @code{insert-rectangle}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16375
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16376 @need 1200
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16377 Indeed, this is the function we want; its documentation says:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16378
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16379 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16380 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16381 insert-rectangle:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16382 Insert text of RECTANGLE with upper left corner at point.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16383 RECTANGLE's first line is inserted at point,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16384 its second line is inserted at a point vertically under point, etc.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16385 RECTANGLE should be a list of strings.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16386 After this command, the mark is at the upper left corner
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16387 and point is at the lower right corner.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16388 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16389 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16390
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16391 We can run a quick test, to make sure it does what we expect of it.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16392
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16393 Here is the result of placing the cursor after the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16394 @code{insert-rectangle} expression and typing @kbd{C-u C-x C-e}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16395 (@code{eval-last-sexp}). The function inserts the strings
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16396 @samp{"first"}, @samp{"second"}, and @samp{"third"} at and below
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16397 point. Also the function returns @code{nil}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16398
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16399 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16400 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16401 (insert-rectangle '("first" "second" "third"))first
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16402 second
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16403 thirdnil
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16404 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16405 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16406
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16407 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16408 Of course, we won't be inserting the text of the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16409 @code{insert-rectangle} expression itself into the buffer in which we
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16410 are making the graph, but will call the function from our program. We
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16411 shall, however, have to make sure that point is in the buffer at the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16412 place where the @code{insert-rectangle} function will insert its
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16413 column of strings.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16414
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16415 If you are reading this in Info, you can see how this works by
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16416 switching to another buffer, such as the @file{*scratch*} buffer,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16417 placing point somewhere in the buffer, typing @kbd{M-:}, typing the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16418 @code{insert-rectangle} expression into the minibuffer at the prompt,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16419 and then typing @key{RET}. This causes Emacs to evaluate the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16420 expression in the minibuffer, but to use as the value of point the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16421 position of point in the @file{*scratch*} buffer. (@kbd{M-:} is the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16422 keybinding for @code{eval-expression}. Also, @code{nil} does not
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16423 appear in the @file{*scratch*} buffer since the expression is
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16424 evaluated in the minibuffer.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16425
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16426 We find when we do this that point ends up at the end of the last
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16427 inserted line---that is to say, this function moves point as a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16428 side-effect. If we were to repeat the command, with point at this
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16429 position, the next insertion would be below and to the right of the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16430 previous insertion. We don't want this! If we are going to make a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16431 bar graph, the columns need to be beside each other.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16432
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16433 So we discover that each cycle of the column-inserting @code{while}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16434 loop must reposition point to the place we want it, and that place
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16435 will be at the top, not the bottom, of the column. Moreover, we
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16436 remember that when we print a graph, we do not expect all the columns
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16437 to be the same height. This means that the top of each column may be
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16438 at a different height from the previous one. We cannot simply
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16439 reposition point to the same line each time, but moved over to the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16440 right---or perhaps we can@dots{}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16441
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16442 We are planning to make the columns of the bar graph out of asterisks.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16443 The number of asterisks in the column is the number specified by the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16444 current element of the @code{numbers-list}. We need to construct a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16445 list of asterisks of the right length for each call to
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16446 @code{insert-rectangle}. If this list consists solely of the requisite
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16447 number of asterisks, then we will have position point the right number
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16448 of lines above the base for the graph to print correctly. This could
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16449 be difficult.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16450
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16451 Alternatively, if we can figure out some way to pass
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16452 @code{insert-rectangle} a list of the same length each time, then we
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16453 can place point on the same line each time, but move it over one
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16454 column to the right for each new column. If we do this, however, some
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16455 of the entries in the list passed to @code{insert-rectangle} must be
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16456 blanks rather than asterisks. For example, if the maximum height of
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16457 the graph is 5, but the height of the column is 3, then
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16458 @code{insert-rectangle} requires an argument that looks like this:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16459
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16460 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16461 (" " " " "*" "*" "*")
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16462 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16463
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16464 This last proposal is not so difficult, so long as we can determine
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16465 the column height. There are two ways for us to specify the column
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16466 height: we can arbitrarily state what it will be, which would work
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16467 fine for graphs of that height; or we can search through the list of
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16468 numbers and use the maximum height of the list as the maximum height
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16469 of the graph. If the latter operation were difficult, then the former
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16470 procedure would be easiest, but there is a function built into Emacs
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16471 that determines the maximum of its arguments. We can use that
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16472 function. The function is called @code{max} and it returns the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16473 largest of all its arguments, which must be numbers. Thus, for
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16474 example,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16475
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16476 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16477 (max 3 4 6 5 7 3)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16478 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16479
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16480 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16481 returns 7. (A corresponding function called @code{min} returns the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16482 smallest of all its arguments.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16483 @findex max
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16484 @findex min
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16485
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16486 However, we cannot simply call @code{max} on the @code{numbers-list};
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16487 the @code{max} function expects numbers as its argument, not a list of
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16488 numbers. Thus, the following expression,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16489
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16490 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16491 (max '(3 4 6 5 7 3))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16492 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16493
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16494 @need 800
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16495 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16496 produces the following error message;
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16497
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16498 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16499 Wrong type of argument: number-or-marker-p, (3 4 6 5 7 3)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16500 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16501
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16502 @findex apply
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16503 We need a function that passes a list of arguments to a function.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16504 This function is @code{apply}. This function `applies' its first
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16505 argument (a function) to its remaining arguments, the last of which
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16506 may be a list.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16507
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16508 @need 1250
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16509 For example,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16510
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16511 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16512 (apply 'max 3 4 7 3 '(4 8 5))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16513 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16514
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16515 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16516 returns 8.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16517
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16518 (Incidentally, I don't know how you would learn of this function
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16519 without a book such as this. It is possible to discover other
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16520 functions, like @code{search-forward} or @code{insert-rectangle}, by
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16521 guessing at a part of their names and then using @code{apropos}. Even
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16522 though its base in metaphor is clear---`apply' its first argument to
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16523 the rest---I doubt a novice would come up with that particular word
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16524 when using @code{apropos} or other aid. Of course, I could be wrong;
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16525 after all, the function was first named by someone who had to invent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16526 it.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16527
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16528 The second and subsequent arguments to @code{apply} are optional, so
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16529 we can use @code{apply} to call a function and pass the elements of a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16530 list to it, like this, which also returns 8:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16531
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16532 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16533 (apply 'max '(4 8 5))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16534 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16535
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16536 This latter way is how we will use @code{apply}. The
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16537 @code{recursive-lengths-list-many-files} function returns a numbers'
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16538 list to which we can apply @code{max} (we could also apply @code{max} to
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16539 the sorted numbers' list; it does not matter whether the list is
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16540 sorted or not.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16541
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16542 @need 800
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16543 Hence, the operation for finding the maximum height of the graph is this:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16544
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16545 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16546 (setq max-graph-height (apply 'max numbers-list))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16547 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16548
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16549 Now we can return to the question of how to create a list of strings
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16550 for a column of the graph. Told the maximum height of the graph
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16551 and the number of asterisks that should appear in the column, the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16552 function should return a list of strings for the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16553 @code{insert-rectangle} command to insert.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16554
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16555 Each column is made up of asterisks or blanks. Since the function is
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16556 passed the value of the height of the column and the number of
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16557 asterisks in the column, the number of blanks can be found by
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16558 subtracting the number of asterisks from the height of the column.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16559 Given the number of blanks and the number of asterisks, two
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16560 @code{while} loops can be used to construct the list:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16561
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16562 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16563 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16564 ;;; @r{First version.}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16565 (defun column-of-graph (max-graph-height actual-height)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16566 "Return list of strings that is one column of a graph."
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16567 (let ((insert-list nil)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16568 (number-of-top-blanks
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16569 (- max-graph-height actual-height)))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16570 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16571
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16572 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16573 ;; @r{Fill in asterisks.}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16574 (while (> actual-height 0)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16575 (setq insert-list (cons "*" insert-list))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16576 (setq actual-height (1- actual-height)))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16577 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16578
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16579 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16580 ;; @r{Fill in blanks.}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16581 (while (> number-of-top-blanks 0)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16582 (setq insert-list (cons " " insert-list))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16583 (setq number-of-top-blanks
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16584 (1- number-of-top-blanks)))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16585 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16586
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16587 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16588 ;; @r{Return whole list.}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16589 insert-list))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16590 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16591 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16592
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16593 If you install this function and then evaluate the following
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16594 expression you will see that it returns the list as desired:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16595
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16596 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16597 (column-of-graph 5 3)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16598 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16599
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16600 @need 800
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16601 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16602 returns
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16603
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16604 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16605 (" " " " "*" "*" "*")
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16606 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16607
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16608 As written, @code{column-of-graph} contains a major flaw: the symbols
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16609 used for the blank and for the marked entries in the column are
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16610 `hard-coded' as a space and asterisk. This is fine for a prototype,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16611 but you, or another user, may wish to use other symbols. For example,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16612 in testing the graph function, you many want to use a period in place
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16613 of the space, to make sure the point is being repositioned properly
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16614 each time the @code{insert-rectangle} function is called; or you might
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16615 want to substitute a @samp{+} sign or other symbol for the asterisk.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16616 You might even want to make a graph-column that is more than one
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16617 display column wide. The program should be more flexible. The way to
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16618 do that is to replace the blank and the asterisk with two variables
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16619 that we can call @code{graph-blank} and @code{graph-symbol} and define
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16620 those variables separately.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16621
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16622 Also, the documentation is not well written. These considerations
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16623 lead us to the second version of the function:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16624
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16625 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16626 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16627 (defvar graph-symbol "*"
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16628 "String used as symbol in graph, usually an asterisk.")
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16629 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16630
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16631 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16632 (defvar graph-blank " "
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16633 "String used as blank in graph, usually a blank space.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16634 graph-blank must be the same number of columns wide
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16635 as graph-symbol.")
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16636 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16637 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16638
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16639 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16640 (For an explanation of @code{defvar}, see
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16641 @ref{defvar, , Initializing a Variable with @code{defvar}}.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16642
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16643 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16644 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16645 ;;; @r{Second version.}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16646 (defun column-of-graph (max-graph-height actual-height)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16647 "Return MAX-GRAPH-HEIGHT strings; ACTUAL-HEIGHT are graph-symbols.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16648
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16649 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16650 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16651 The graph-symbols are contiguous entries at the end
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16652 of the list.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16653 The list will be inserted as one column of a graph.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16654 The strings are either graph-blank or graph-symbol."
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16655 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16656
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16657 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16658 (let ((insert-list nil)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16659 (number-of-top-blanks
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16660 (- max-graph-height actual-height)))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16661 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16662
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16663 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16664 ;; @r{Fill in @code{graph-symbols}.}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16665 (while (> actual-height 0)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16666 (setq insert-list (cons graph-symbol insert-list))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16667 (setq actual-height (1- actual-height)))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16668 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16669
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16670 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16671 ;; @r{Fill in @code{graph-blanks}.}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16672 (while (> number-of-top-blanks 0)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16673 (setq insert-list (cons graph-blank insert-list))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16674 (setq number-of-top-blanks
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16675 (1- number-of-top-blanks)))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16676
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16677 ;; @r{Return whole list.}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16678 insert-list))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16679 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16680 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16681
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16682 If we wished, we could rewrite @code{column-of-graph} a third time to
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16683 provide optionally for a line graph as well as for a bar graph. This
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16684 would not be hard to do. One way to think of a line graph is that it
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16685 is no more than a bar graph in which the part of each bar that is
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16686 below the top is blank. To construct a column for a line graph, the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16687 function first constructs a list of blanks that is one shorter than
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16688 the value, then it uses @code{cons} to attach a graph symbol to the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16689 list; then it uses @code{cons} again to attach the `top blanks' to
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16690 the list.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16691
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16692 It is easy to see how to write such a function, but since we don't
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16693 need it, we will not do it. But the job could be done, and if it were
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16694 done, it would be done with @code{column-of-graph}. Even more
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16695 important, it is worth noting that few changes would have to be made
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16696 anywhere else. The enhancement, if we ever wish to make it, is
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16697 simple.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16698
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16699 Now, finally, we come to our first actual graph printing function.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16700 This prints the body of a graph, not the labels for the vertical and
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16701 horizontal axes, so we can call this @code{graph-body-print}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16702
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16703 @node graph-body-print, recursive-graph-body-print, Columns of a graph, Readying a Graph
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16704 @section The @code{graph-body-print} Function
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16705 @findex graph-body-print
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16706
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16707 After our preparation in the preceding section, the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16708 @code{graph-body-print} function is straightforward. The function
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16709 will print column after column of asterisks and blanks, using the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16710 elements of a numbers' list to specify the number of asterisks in each
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16711 column. This is a repetitive act, which means we can use a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16712 decrementing @code{while} loop or recursive function for the job. In
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16713 this section, we will write the definition using a @code{while} loop.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16714
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16715 The @code{column-of-graph} function requires the height of the graph
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16716 as an argument, so we should determine and record that as a local variable.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16717
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16718 This leads us to the following template for the @code{while} loop
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16719 version of this function:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16720
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16721 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16722 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16723 (defun graph-body-print (numbers-list)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16724 "@var{documentation}@dots{}"
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16725 (let ((height @dots{}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16726 @dots{}))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16727 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16728
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16729 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16730 (while numbers-list
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16731 @var{insert-columns-and-reposition-point}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16732 (setq numbers-list (cdr numbers-list)))))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16733 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16734 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16735
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16736 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16737 We need to fill in the slots of the template.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16738
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16739 Clearly, we can use the @code{(apply 'max numbers-list)} expression to
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16740 determine the height of the graph.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16741
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16742 The @code{while} loop will cycle through the @code{numbers-list} one
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16743 element at a time. As it is shortened by the @code{(setq numbers-list
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16744 (cdr numbers-list))} expression, the @sc{car} of each instance of the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16745 list is the value of the argument for @code{column-of-graph}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16746
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16747 At each cycle of the @code{while} loop, the @code{insert-rectangle}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16748 function inserts the list returned by @code{column-of-graph}. Since
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16749 the @code{insert-rectangle} function moves point to the lower right of
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16750 the inserted rectangle, we need to save the location of point at the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16751 time the rectangle is inserted, move back to that position after the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16752 rectangle is inserted, and then move horizontally to the next place
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16753 from which @code{insert-rectangle} is called.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16754
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16755 If the inserted columns are one character wide, as they will be if
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16756 single blanks and asterisks are used, the repositioning command is
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16757 simply @code{(forward-char 1)}; however, the width of a column may be
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16758 greater than one. This means that the repositioning command should be
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16759 written @code{(forward-char symbol-width)}. The @code{symbol-width}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16760 itself is the length of a @code{graph-blank} and can be found using
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16761 the expression @code{(length graph-blank)}. The best place to bind
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16762 the @code{symbol-width} variable to the value of the width of graph
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16763 column is in the varlist of the @code{let} expression.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16764
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16765 @need 1250
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16766 These considerations lead to the following function definition:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16767
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16768 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16769 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16770 (defun graph-body-print (numbers-list)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16771 "Print a bar graph of the NUMBERS-LIST.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16772 The numbers-list consists of the Y-axis values."
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16773
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16774 (let ((height (apply 'max numbers-list))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16775 (symbol-width (length graph-blank))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16776 from-position)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16777 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16778
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16779 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16780 (while numbers-list
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16781 (setq from-position (point))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16782 (insert-rectangle
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16783 (column-of-graph height (car numbers-list)))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16784 (goto-char from-position)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16785 (forward-char symbol-width)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16786 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16787 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16788 ;; @r{Draw graph column by column.}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16789 (sit-for 0)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16790 (setq numbers-list (cdr numbers-list)))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16791 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16792 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16793 ;; @r{Place point for X axis labels.}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16794 (forward-line height)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16795 (insert "\n")
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16796 ))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16797 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16798 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16799
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16800 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16801 The one unexpected expression in this function is the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16802 @w{@code{(sit-for 0)}} expression in the @code{while} loop. This
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16803 expression makes the graph printing operation more interesting to
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16804 watch than it would be otherwise. The expression causes Emacs to
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16805 `sit' or do nothing for a zero length of time and then redraw the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16806 screen. Placed here, it causes Emacs to redraw the screen column by
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16807 column. Without it, Emacs would not redraw the screen until the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16808 function exits.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16809
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16810 We can test @code{graph-body-print} with a short list of numbers.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16811
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16812 @enumerate
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16813 @item
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16814 Install @code{graph-symbol}, @code{graph-blank},
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16815 @code{column-of-graph}, which are in
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16816 @iftex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16817 @ref{Readying a Graph, , Readying a Graph},
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16818 @end iftex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16819 @ifinfo
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16820 @ref{Columns of a graph},
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16821 @end ifinfo
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16822 and @code{graph-body-print}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16823
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16824 @need 800
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16825 @item
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16826 Copy the following expression:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16827
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16828 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16829 (graph-body-print '(1 2 3 4 6 4 3 5 7 6 5 2 3))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16830 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16831
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16832 @item
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16833 Switch to the @file{*scratch*} buffer and place the cursor where you
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16834 want the graph to start.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16835
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16836 @item
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16837 Type @kbd{M-:} (@code{eval-expression}).
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16838
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16839 @item
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16840 Yank the @code{graph-body-print} expression into the minibuffer
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16841 with @kbd{C-y} (@code{yank)}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16842
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16843 @item
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16844 Press @key{RET} to evaluate the @code{graph-body-print} expression.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16845 @end enumerate
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16846
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16847 @need 800
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16848 Emacs will print a graph like this:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16849
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16850 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16851 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16852 *
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16853 * **
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16854 * ****
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16855 *** ****
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16856 ********* *
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16857 ************
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16858 *************
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16859 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16860 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16861
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16862 @node recursive-graph-body-print, Printed Axes, graph-body-print, Readying a Graph
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16863 @section The @code{recursive-graph-body-print} Function
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16864 @findex recursive-graph-body-print
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16865
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16866 The @code{graph-body-print} function may also be written recursively.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16867 The recursive solution is divided into two parts: an outside `wrapper'
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16868 that uses a @code{let} expression to determine the values of several
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16869 variables that need only be found once, such as the maximum height of
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16870 the graph, and an inside function that is called recursively to print
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16871 the graph.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16872
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16873 @need 1250
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16874 The `wrapper' is uncomplicated:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16875
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16876 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16877 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16878 (defun recursive-graph-body-print (numbers-list)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16879 "Print a bar graph of the NUMBERS-LIST.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16880 The numbers-list consists of the Y-axis values."
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16881 (let ((height (apply 'max numbers-list))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16882 (symbol-width (length graph-blank))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16883 from-position)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16884 (recursive-graph-body-print-internal
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16885 numbers-list
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16886 height
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16887 symbol-width)))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16888 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16889 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16890
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16891 The recursive function is a little more difficult. It has four parts:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16892 the `do-again-test', the printing code, the recursive call, and the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16893 `next-step-expression'. The `do-again-test' is a @code{when}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16894 expression that determines whether the @code{numbers-list} contains
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16895 any remaining elements; if it does, the function prints one column of
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16896 the graph using the printing code and calls itself again. The
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16897 function calls itself again according to the value produced by the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16898 `next-step-expression' which causes the call to act on a shorter
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16899 version of the @code{numbers-list}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16900
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16901 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16902 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16903 (defun recursive-graph-body-print-internal
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16904 (numbers-list height symbol-width)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16905 "Print a bar graph.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16906 Used within recursive-graph-body-print function."
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16907 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16908
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16909 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16910 (when numbers-list
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16911 (setq from-position (point))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16912 (insert-rectangle
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16913 (column-of-graph height (car numbers-list)))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16914 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16915 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16916 (goto-char from-position)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16917 (forward-char symbol-width)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16918 (sit-for 0) ; @r{Draw graph column by column.}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16919 (recursive-graph-body-print-internal
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16920 (cdr numbers-list) height symbol-width)))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16921 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16922 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16923
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16924 @need 1250
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16925 After installation, this expression can be tested; here is a sample:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16926
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16927 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16928 (recursive-graph-body-print '(3 2 5 6 7 5 3 4 6 4 3 2 1))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16929 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16930
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16931 @need 800
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16932 Here is what @code{recursive-graph-body-print} produces:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16933
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16934 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16935 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16936 *
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16937 ** *
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16938 **** *
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16939 **** ***
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16940 * *********
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16941 ************
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16942 *************
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16943 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16944 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16945
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16946 Either of these two functions, @code{graph-body-print} or
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16947 @code{recursive-graph-body-print}, create the body of a graph.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16948
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16949 @node Printed Axes, Line Graph Exercise, recursive-graph-body-print, Readying a Graph
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16950 @section Need for Printed Axes
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16951
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16952 A graph needs printed axes, so you can orient yourself. For a do-once
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16953 project, it may be reasonable to draw the axes by hand using Emacs'
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16954 Picture mode; but a graph drawing function may be used more than once.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16955
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16956 For this reason, I have written enhancements to the basic
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16957 @code{print-graph-body} function that automatically print labels for
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16958 the horizontal and vertical axes. Since the label printing functions
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16959 do not contain much new material, I have placed their description in
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16960 an appendix. @xref{Full Graph, , A Graph with Labelled Axes}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16961
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16962 @node Line Graph Exercise, , Printed Axes, Readying a Graph
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16963 @section Exercise
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16964
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16965 Write a line graph version of the graph printing functions.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16966
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16967 @node Emacs Initialization, Debugging, Readying a Graph, Top
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16968 @chapter Your @file{.emacs} File
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16969 @cindex @file{.emacs} file
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16970 @cindex Customizing your @file{.emacs} file
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16971 @cindex Initialization file
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16972
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16973 ``You don't have to like Emacs to like it'' -- this seemingly
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16974 paradoxical statement is the secret of GNU Emacs. The plain, `out of
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16975 the box' Emacs is a generic tool. Most people who use it, customize
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16976 it to suit themselves.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16977
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16978 GNU Emacs is mostly written in Emacs Lisp; this means that by writing
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16979 expressions in Emacs Lisp you can change or extend Emacs.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16980
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16981 @menu
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16982 * Default Configuration::
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16983 * Site-wide Init:: You can write site-wide init files.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16984 * defcustom:: Emacs will write code for you.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16985 * Beginning a .emacs File:: How to write a @code{.emacs file}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16986 * Text and Auto-fill:: Automatically wrap lines.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16987 * Mail Aliases:: Use abbreviations for email addresses.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16988 * Indent Tabs Mode:: Don't use tabs with @TeX{}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16989 * Keybindings:: Create some personal keybindings.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16990 * Keymaps:: More about key binding.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16991 * Loading Files:: Load (i.e., evaluate) files automatically.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16992 * Autoload:: Make functions available.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16993 * Simple Extension:: Define a function; bind it to a key.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16994 * X11 Colors:: Colors in X.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16995 * Miscellaneous::
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16996 * Mode Line:: How to customize your mode line.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16997 @end menu
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16998
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16999 @node Default Configuration, Site-wide Init, Emacs Initialization, Emacs Initialization
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17000 @ifnottex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17001 @unnumberedsec Emacs' Default Configuration
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17002 @end ifnottex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17003
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17004 There are those who appreciate Emacs' default configuration. After
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17005 all, Emacs starts you in C mode when you edit a C file, starts you in
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17006 Fortran mode when you edit a Fortran file, and starts you in
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17007 Fundamental mode when you edit an unadorned file. This all makes
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17008 sense, if you do not know who is going to use Emacs. Who knows what a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17009 person hopes to do with an unadorned file? Fundamental mode is the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17010 right default for such a file, just as C mode is the right default for
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17011 editing C code. (Enough programming languages have syntaxes
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17012 that enable them to share or nearly share features, so C mode is
102187
b5d077a43e1c dup word by
Karl Berry <karl@gnu.org>
parents: 102151
diff changeset
17013 now provided by CC mode, the `C Collection'.)
83955
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17014
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17015 But when you do know who is going to use Emacs---you,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17016 yourself---then it makes sense to customize Emacs.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17017
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17018 For example, I seldom want Fundamental mode when I edit an
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17019 otherwise undistinguished file; I want Text mode. This is why I
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17020 customize Emacs: so it suits me.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17021
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17022 You can customize and extend Emacs by writing or adapting a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17023 @file{~/.emacs} file. This is your personal initialization file; its
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17024 contents, written in Emacs Lisp, tell Emacs what to do.@footnote{You
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17025 may also add @file{.el} to @file{~/.emacs} and call it a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17026 @file{~/.emacs.el} file. In the past, you were forbidden to type the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17027 extra keystrokes that the name @file{~/.emacs.el} requires, but now
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17028 you may. The new format is consistent with the Emacs Lisp file
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17029 naming conventions; the old format saves typing.}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17030
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17031 A @file{~/.emacs} file contains Emacs Lisp code. You can write this
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17032 code yourself; or you can use Emacs' @code{customize} feature to write
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17033 the code for you. You can combine your own expressions and
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17034 auto-written Customize expressions in your @file{.emacs} file.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17035
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17036 (I myself prefer to write my own expressions, except for those,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17037 particularly fonts, that I find easier to manipulate using the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17038 @code{customize} command. I combine the two methods.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17039
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17040 Most of this chapter is about writing expressions yourself. It
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17041 describes a simple @file{.emacs} file; for more information, see
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17042 @ref{Init File, , The Init File, emacs, The GNU Emacs Manual}, and
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17043 @ref{Init File, , The Init File, elisp, The GNU Emacs Lisp Reference
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17044 Manual}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17045
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17046 @node Site-wide Init, defcustom, Default Configuration, Emacs Initialization
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17047 @section Site-wide Initialization Files
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17048
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17049 @cindex @file{default.el} init file
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17050 @cindex @file{site-init.el} init file
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17051 @cindex @file{site-load.el} init file
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17052 In addition to your personal initialization file, Emacs automatically
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17053 loads various site-wide initialization files, if they exist. These
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17054 have the same form as your @file{.emacs} file, but are loaded by
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17055 everyone.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17056
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17057 Two site-wide initialization files, @file{site-load.el} and
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17058 @file{site-init.el}, are loaded into Emacs and then `dumped' if a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17059 `dumped' version of Emacs is created, as is most common. (Dumped
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17060 copies of Emacs load more quickly. However, once a file is loaded and
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17061 dumped, a change to it does not lead to a change in Emacs unless you
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17062 load it yourself or re-dump Emacs. @xref{Building Emacs, , Building
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17063 Emacs, elisp, The GNU Emacs Lisp Reference Manual}, and the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17064 @file{INSTALL} file.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17065
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17066 Three other site-wide initialization files are loaded automatically
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17067 each time you start Emacs, if they exist. These are
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17068 @file{site-start.el}, which is loaded @emph{before} your @file{.emacs}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17069 file, and @file{default.el}, and the terminal type file, which are both
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17070 loaded @emph{after} your @file{.emacs} file.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17071
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17072 Settings and definitions in your @file{.emacs} file will overwrite
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17073 conflicting settings and definitions in a @file{site-start.el} file,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17074 if it exists; but the settings and definitions in a @file{default.el}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17075 or terminal type file will overwrite those in your @file{.emacs} file.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17076 (You can prevent interference from a terminal type file by setting
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17077 @code{term-file-prefix} to @code{nil}. @xref{Simple Extension, , A
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17078 Simple Extension}.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17079
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17080 @c Rewritten to avoid overfull hbox.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17081 The @file{INSTALL} file that comes in the distribution contains
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17082 descriptions of the @file{site-init.el} and @file{site-load.el} files.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17083
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17084 The @file{loadup.el}, @file{startup.el}, and @file{loaddefs.el} files
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17085 control loading. These files are in the @file{lisp} directory of the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17086 Emacs distribution and are worth perusing.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17087
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17088 The @file{loaddefs.el} file contains a good many suggestions as to
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17089 what to put into your own @file{.emacs} file, or into a site-wide
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17090 initialization file.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17091
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17092 @node defcustom, Beginning a .emacs File, Site-wide Init, Emacs Initialization
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17093 @section Specifying Variables using @code{defcustom}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17094 @findex defcustom
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17095
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17096 You can specify variables using @code{defcustom} so that you and
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17097 others can then use Emacs' @code{customize} feature to set their
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17098 values. (You cannot use @code{customize} to write function
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17099 definitions; but you can write @code{defuns} in your @file{.emacs}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17100 file. Indeed, you can write any Lisp expression in your @file{.emacs}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17101 file.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17102
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17103 The @code{customize} feature depends on the @code{defcustom} special
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17104 form. Although you can use @code{defvar} or @code{setq} for variables
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17105 that users set, the @code{defcustom} special form is designed for the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17106 job.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17107
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17108 You can use your knowledge of @code{defvar} for writing the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17109 first three arguments for @code{defcustom}. The first argument to
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17110 @code{defcustom} is the name of the variable. The second argument is
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17111 the variable's initial value, if any; and this value is set only if
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17112 the value has not already been set. The third argument is the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17113 documentation.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17114
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17115 The fourth and subsequent arguments to @code{defcustom} specify types
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17116 and options; these are not featured in @code{defvar}. (These
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17117 arguments are optional.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17118
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17119 Each of these arguments consists of a keyword followed by a value.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17120 Each keyword starts with the colon character @samp{:}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17121
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17122 @need 1250
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17123 For example, the customizable user option variable
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17124 @code{text-mode-hook} looks like this:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17125
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17126 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17127 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17128 (defcustom text-mode-hook nil
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17129 "Normal hook run when entering Text mode and many related modes."
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17130 :type 'hook
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17131 :options '(turn-on-auto-fill flyspell-mode)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17132 :group 'data)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17133 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17134 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17135
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17136 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17137 The name of the variable is @code{text-mode-hook}; it has no default
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17138 value; and its documentation string tells you what it does.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17139
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17140 The @code{:type} keyword tells Emacs the kind of data to which
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17141 @code{text-mode-hook} should be set and how to display the value in a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17142 Customization buffer.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17143
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17144 The @code{:options} keyword specifies a suggested list of values for
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17145 the variable. Usually, @code{:options} applies to a hook.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17146 The list is only a suggestion; it is not exclusive; a person who sets
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17147 the variable may set it to other values; the list shown following the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17148 @code{:options} keyword is intended to offer convenient choices to a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17149 user.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17150
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17151 Finally, the @code{:group} keyword tells the Emacs Customization
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17152 command in which group the variable is located. This tells where to
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17153 find it.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17154
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17155 The @code{defcustom} function recognizes more than a dozen keywords.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17156 For more information, see @ref{Customization, , Writing Customization
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17157 Definitions, elisp, The GNU Emacs Lisp Reference Manual}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17158
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17159 Consider @code{text-mode-hook} as an example.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17160
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17161 There are two ways to customize this variable. You can use the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17162 customization command or write the appropriate expressions yourself.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17163
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17164 @need 800
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17165 Using the customization command, you can type:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17166
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17167 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17168 M-x customize
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17169 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17170
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17171 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17172 and find that the group for editing files of data is called `data'.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17173 Enter that group. Text Mode Hook is the first member. You can click
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17174 on its various options, such as @code{turn-on-auto-fill}, to set the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17175 values. After you click on the button to
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17176
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17177 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17178 Save for Future Sessions
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17179 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17180
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17181 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17182 Emacs will write an expression into your @file{.emacs} file.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17183 It will look like this:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17184
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17185 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17186 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17187 (custom-set-variables
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17188 ;; custom-set-variables was added by Custom.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17189 ;; If you edit it by hand, you could mess it up, so be careful.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17190 ;; Your init file should contain only one such instance.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17191 ;; If there is more than one, they won't work right.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17192 '(text-mode-hook (quote (turn-on-auto-fill text-mode-hook-identify))))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17193 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17194 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17195
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17196 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17197 (The @code{text-mode-hook-identify} function tells
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17198 @code{toggle-text-mode-auto-fill} which buffers are in Text mode.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17199 It comes on automatically.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17200
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17201 The @code{custom-set-variables} function works somewhat differently
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17202 than a @code{setq}. While I have never learned the differences, I
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17203 modify the @code{custom-set-variables} expressions in my @file{.emacs}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17204 file by hand: I make the changes in what appears to me to be a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17205 reasonable manner and have not had any problems. Others prefer to use
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17206 the Customization command and let Emacs do the work for them.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17207
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17208 Another @code{custom-set-@dots{}} function is @code{custom-set-faces}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17209 This function sets the various font faces. Over time, I have set a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17210 considerable number of faces. Some of the time, I re-set them using
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17211 @code{customize}; other times, I simply edit the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17212 @code{custom-set-faces} expression in my @file{.emacs} file itself.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17213
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17214 The second way to customize your @code{text-mode-hook} is to set it
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17215 yourself in your @file{.emacs} file using code that has nothing to do
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17216 with the @code{custom-set-@dots{}} functions.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17217
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17218 @need 800
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17219 When you do this, and later use @code{customize}, you will see a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17220 message that says
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17221
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17222 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17223 CHANGED outside Customize; operating on it here may be unreliable.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17224 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17225
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17226 @need 800
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17227 This message is only a warning. If you click on the button to
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17228
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17229 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17230 Save for Future Sessions
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17231 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17232
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17233 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17234 Emacs will write a @code{custom-set-@dots{}} expression near the end
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17235 of your @file{.emacs} file that will be evaluated after your
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17236 hand-written expression. It will, therefore, overrule your
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17237 hand-written expression. No harm will be done. When you do this,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17238 however, be careful to remember which expression is active; if you
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17239 forget, you may confuse yourself.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17240
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17241 So long as you remember where the values are set, you will have no
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17242 trouble. In any event, the values are always set in your
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17243 initialization file, which is usually called @file{.emacs}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17244
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17245 I myself use @code{customize} for hardly anything. Mostly, I write
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17246 expressions myself.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17247
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17248 @findex defsubst
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17249 @findex defconst
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17250 Incidentally, to be more complete concerning defines: @code{defsubst}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17251 defines an inline function. The syntax is just like that of
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17252 @code{defun}. @code{defconst} defines a symbol as a constant. The
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17253 intent is that neither programs nor users should ever change a value
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17254 set by @code{defconst}. (You can change it; the value set is a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17255 variable; but please do not.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17256
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17257 @node Beginning a .emacs File, Text and Auto-fill, defcustom, Emacs Initialization
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17258 @section Beginning a @file{.emacs} File
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17259 @cindex @file{.emacs} file, beginning of
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17260
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17261 When you start Emacs, it loads your @file{.emacs} file unless you tell
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17262 it not to by specifying @samp{-q} on the command line. (The
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17263 @code{emacs -q} command gives you a plain, out-of-the-box Emacs.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17264
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17265 A @file{.emacs} file contains Lisp expressions. Often, these are no
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17266 more than expressions to set values; sometimes they are function
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17267 definitions.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17268
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17269 @xref{Init File, , The Init File @file{~/.emacs}, emacs, The GNU Emacs
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17270 Manual}, for a short description of initialization files.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17271
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17272 This chapter goes over some of the same ground, but is a walk among
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17273 extracts from a complete, long-used @file{.emacs} file---my own.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17274
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17275 The first part of the file consists of comments: reminders to myself.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17276 By now, of course, I remember these things, but when I started, I did
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17277 not.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17278
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17279 @need 1200
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17280 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17281 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17282 ;;;; Bob's .emacs file
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17283 ; Robert J. Chassell
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17284 ; 26 September 1985
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17285 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17286 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17287
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17288 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17289 Look at that date! I started this file a long time ago. I have been
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17290 adding to it ever since.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17291
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17292 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17293 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17294 ; Each section in this file is introduced by a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17295 ; line beginning with four semicolons; and each
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17296 ; entry is introduced by a line beginning with
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17297 ; three semicolons.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17298 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17299 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17300
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17301 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17302 This describes the usual conventions for comments in Emacs Lisp.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17303 Everything on a line that follows a semicolon is a comment. Two,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17304 three, and four semicolons are used as subsection and section markers.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17305 (@xref{Comments, ,, elisp, The GNU Emacs Lisp Reference Manual}, for
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17306 more about comments.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17307
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17308 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17309 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17310 ;;;; The Help Key
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17311 ; Control-h is the help key;
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17312 ; after typing control-h, type a letter to
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17313 ; indicate the subject about which you want help.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17314 ; For an explanation of the help facility,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17315 ; type control-h two times in a row.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17316 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17317 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17318
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17319 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17320 Just remember: type @kbd{C-h} two times for help.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17321
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17322 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17323 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17324 ; To find out about any mode, type control-h m
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17325 ; while in that mode. For example, to find out
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17326 ; about mail mode, enter mail mode and then type
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17327 ; control-h m.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17328 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17329 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17330
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17331 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17332 `Mode help', as I call this, is very helpful. Usually, it tells you
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17333 all you need to know.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17334
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17335 Of course, you don't need to include comments like these in your
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17336 @file{.emacs} file. I included them in mine because I kept forgetting
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17337 about Mode help or the conventions for comments---but I was able to
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17338 remember to look here to remind myself.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17339
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17340 @node Text and Auto-fill, Mail Aliases, Beginning a .emacs File, Emacs Initialization
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17341 @section Text and Auto Fill Mode
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17342
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17343 Now we come to the part that `turns on' Text mode and
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17344 Auto Fill mode.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17345
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17346 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17347 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17348 ;;; Text mode and Auto Fill mode
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17349 ; The next two lines put Emacs into Text mode
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17350 ; and Auto Fill mode, and are for writers who
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17351 ; want to start writing prose rather than code.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17352 (setq default-major-mode 'text-mode)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17353 (add-hook 'text-mode-hook 'turn-on-auto-fill)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17354 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17355 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17356
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17357 Here is the first part of this @file{.emacs} file that does something
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17358 besides remind a forgetful human!
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17359
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17360 The first of the two lines in parentheses tells Emacs to turn on Text
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17361 mode when you find a file, @emph{unless} that file should go into some
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17362 other mode, such as C mode.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17363
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17364 @cindex Per-buffer, local variables list
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17365 @cindex Local variables list, per-buffer,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17366 @cindex Automatic mode selection
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17367 @cindex Mode selection, automatic
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17368 When Emacs reads a file, it looks at the extension to the file name,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17369 if any. (The extension is the part that comes after a @samp{.}.) If
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17370 the file ends with a @samp{.c} or @samp{.h} extension then Emacs turns
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17371 on C mode. Also, Emacs looks at first nonblank line of the file; if
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17372 the line says @w{@samp{-*- C -*-}}, Emacs turns on C mode. Emacs
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17373 possesses a list of extensions and specifications that it uses
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17374 automatically. In addition, Emacs looks near the last page for a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17375 per-buffer, ``local variables list'', if any.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17376
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17377 @ifinfo
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17378 @xref{Choosing Modes, , How Major Modes are Chosen, emacs, The GNU
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17379 Emacs Manual}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17380
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17381 @xref{File Variables, , Local Variables in Files, emacs, The GNU Emacs
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17382 Manual}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17383 @end ifinfo
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17384 @iftex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17385 See sections ``How Major Modes are Chosen'' and ``Local Variables in
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17386 Files'' in @cite{The GNU Emacs Manual}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17387 @end iftex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17388
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17389 Now, back to the @file{.emacs} file.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17390
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17391 @need 800
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17392 Here is the line again; how does it work?
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17393
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17394 @cindex Text Mode turned on
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17395 @smallexample
104626
caa79498564a * subr.el (default-mode-line-format, default-header-line-format)
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 104095
diff changeset
17396 (setq major-mode 'text-mode)
83955
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17397 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17398
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17399 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17400 This line is a short, but complete Emacs Lisp expression.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17401
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17402 We are already familiar with @code{setq}. It sets the following variable,
104626
caa79498564a * subr.el (default-mode-line-format, default-header-line-format)
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 104095
diff changeset
17403 @code{major-mode}, to the subsequent value, which is @code{text-mode}.
caa79498564a * subr.el (default-mode-line-format, default-header-line-format)
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 104095
diff changeset
17404 The single quote mark before @code{text-mode} tells Emacs to deal directly
caa79498564a * subr.el (default-mode-line-format, default-header-line-format)
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 104095
diff changeset
17405 with the @code{text-mode} symbol, not with whatever it might stand for.
caa79498564a * subr.el (default-mode-line-format, default-header-line-format)
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 104095
diff changeset
17406 @xref{set & setq, , Setting the Value of a Variable},
caa79498564a * subr.el (default-mode-line-format, default-header-line-format)
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 104095
diff changeset
17407 for a reminder of how @code{setq} works.
caa79498564a * subr.el (default-mode-line-format, default-header-line-format)
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 104095
diff changeset
17408 The main point is that there is no difference between the procedure you
caa79498564a * subr.el (default-mode-line-format, default-header-line-format)
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 104095
diff changeset
17409 use to set a value in your @file{.emacs} file and the procedure you use
caa79498564a * subr.el (default-mode-line-format, default-header-line-format)
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 104095
diff changeset
17410 anywhere else in Emacs.
83955
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17411
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17412 @need 800
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17413 Here is the next line:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17414
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17415 @cindex Auto Fill mode turned on
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17416 @findex add-hook
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17417 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17418 (add-hook 'text-mode-hook 'turn-on-auto-fill)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17419 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17420
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17421 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17422 In this line, the @code{add-hook} command adds
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17423 @code{turn-on-auto-fill} to the variable.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17424
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17425 @code{turn-on-auto-fill} is the name of a program, that, you guessed
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17426 it!, turns on Auto Fill mode.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17427
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17428 Every time Emacs turns on Text mode, Emacs runs the commands `hooked'
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17429 onto Text mode. So every time Emacs turns on Text mode, Emacs also
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17430 turns on Auto Fill mode.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17431
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17432 In brief, the first line causes Emacs to enter Text mode when you edit a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17433 file, unless the file name extension, a first non-blank line, or local
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17434 variables to tell Emacs otherwise.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17435
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17436 Text mode among other actions, sets the syntax table to work
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17437 conveniently for writers. In Text mode, Emacs considers an apostrophe
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17438 as part of a word like a letter; but Emacs does not consider a period
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17439 or a space as part of a word. Thus, @kbd{M-f} moves you over
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17440 @samp{it's}. On the other hand, in C mode, @kbd{M-f} stops just after
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17441 the @samp{t} of @samp{it's}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17442
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17443 The second line causes Emacs to turn on Auto Fill mode when it turns
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17444 on Text mode. In Auto Fill mode, Emacs automatically breaks a line
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17445 that is too wide and brings the excessively wide part of the line down
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17446 to the next line. Emacs breaks lines between words, not within them.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17447
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17448 When Auto Fill mode is turned off, lines continue to the right as you
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17449 type them. Depending on how you set the value of
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17450 @code{truncate-lines}, the words you type either disappear off the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17451 right side of the screen, or else are shown, in a rather ugly and
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17452 unreadable manner, as a continuation line on the screen.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17453
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17454 @need 1250
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17455 In addition, in this part of my @file{.emacs} file, I tell the Emacs
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17456 fill commands to insert two spaces after a colon:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17457
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17458 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17459 (setq colon-double-space t)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17460 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17461
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17462 @node Mail Aliases, Indent Tabs Mode, Text and Auto-fill, Emacs Initialization
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17463 @section Mail Aliases
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17464
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17465 Here is a @code{setq} that `turns on' mail aliases, along with more
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17466 reminders.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17467
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17468 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17469 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17470 ;;; Mail mode
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17471 ; To enter mail mode, type `C-x m'
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17472 ; To enter RMAIL (for reading mail),
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17473 ; type `M-x rmail'
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17474 (setq mail-aliases t)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17475 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17476 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17477
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17478 @cindex Mail aliases
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17479 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17480 This @code{setq} command sets the value of the variable
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17481 @code{mail-aliases} to @code{t}. Since @code{t} means true, the line
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17482 says, in effect, ``Yes, use mail aliases.''
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17483
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17484 Mail aliases are convenient short names for long email addresses or
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17485 for lists of email addresses. The file where you keep your `aliases'
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17486 is @file{~/.mailrc}. You write an alias like this:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17487
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17488 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17489 alias geo george@@foobar.wiz.edu
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17490 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17491
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17492 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17493 When you write a message to George, address it to @samp{geo}; the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17494 mailer will automatically expand @samp{geo} to the full address.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17495
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17496 @node Indent Tabs Mode, Keybindings, Mail Aliases, Emacs Initialization
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17497 @section Indent Tabs Mode
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17498 @cindex Tabs, preventing
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17499 @findex indent-tabs-mode
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17500
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17501 By default, Emacs inserts tabs in place of multiple spaces when it
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17502 formats a region. (For example, you might indent many lines of text
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17503 all at once with the @code{indent-region} command.) Tabs look fine on
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17504 a terminal or with ordinary printing, but they produce badly indented
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17505 output when you use @TeX{} or Texinfo since @TeX{} ignores tabs.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17506
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17507 @need 1250
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17508 The following turns off Indent Tabs mode:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17509
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17510 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17511 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17512 ;;; Prevent Extraneous Tabs
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17513 (setq-default indent-tabs-mode nil)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17514 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17515 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17516
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17517 Note that this line uses @code{setq-default} rather than the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17518 @code{setq} command that we have seen before. The @code{setq-default}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17519 command sets values only in buffers that do not have their own local
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17520 values for the variable.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17521
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17522 @ifinfo
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17523 @xref{Just Spaces, , Tabs vs. Spaces, emacs, The GNU Emacs Manual}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17524
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17525 @xref{File Variables, , Local Variables in Files, emacs, The GNU Emacs
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17526 Manual}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17527 @end ifinfo
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17528 @iftex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17529 See sections ``Tabs vs.@: Spaces'' and ``Local Variables in
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17530 Files'' in @cite{The GNU Emacs Manual}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17531 @end iftex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17532
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17533 @need 1700
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17534 @node Keybindings, Keymaps, Indent Tabs Mode, Emacs Initialization
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17535 @section Some Keybindings
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17536
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17537 Now for some personal keybindings:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17538
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17539 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17540 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17541 ;;; Compare windows
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17542 (global-set-key "\C-cw" 'compare-windows)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17543 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17544 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17545
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17546 @findex compare-windows
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17547 @code{compare-windows} is a nifty command that compares the text in
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17548 your current window with text in the next window. It makes the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17549 comparison by starting at point in each window, moving over text in
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17550 each window as far as they match. I use this command all the time.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17551
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17552 This also shows how to set a key globally, for all modes.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17553
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17554 @cindex Setting a key globally
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17555 @cindex Global set key
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17556 @cindex Key setting globally
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17557 @findex global-set-key
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17558 The command is @code{global-set-key}. It is followed by the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17559 keybinding. In a @file{.emacs} file, the keybinding is written as
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17560 shown: @code{\C-c} stands for `control-c', which means `press the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17561 control key and the @key{c} key at the same time'. The @code{w} means
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17562 `press the @key{w} key'. The keybinding is surrounded by double
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17563 quotation marks. In documentation, you would write this as
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17564 @w{@kbd{C-c w}}. (If you were binding a @key{META} key, such as
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17565 @kbd{M-c}, rather than a @key{CTRL} key, you would write
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17566 @w{@code{\M-c}} in your @file{.emacs} file. @xref{Init Rebinding, ,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17567 Rebinding Keys in Your Init File, emacs, The GNU Emacs Manual}, for
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17568 details.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17569
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17570 The command invoked by the keys is @code{compare-windows}. Note that
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17571 @code{compare-windows} is preceded by a single quote; otherwise, Emacs
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17572 would first try to evaluate the symbol to determine its value.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17573
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17574 These three things, the double quotation marks, the backslash before
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17575 the @samp{C}, and the single quote mark are necessary parts of
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17576 keybinding that I tend to forget. Fortunately, I have come to
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17577 remember that I should look at my existing @file{.emacs} file, and
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17578 adapt what is there.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17579
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17580 As for the keybinding itself: @kbd{C-c w}. This combines the prefix
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17581 key, @kbd{C-c}, with a single character, in this case, @kbd{w}. This
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17582 set of keys, @kbd{C-c} followed by a single character, is strictly
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17583 reserved for individuals' own use. (I call these `own' keys, since
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17584 these are for my own use.) You should always be able to create such a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17585 keybinding for your own use without stomping on someone else's
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17586 keybinding. If you ever write an extension to Emacs, please avoid
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17587 taking any of these keys for public use. Create a key like @kbd{C-c
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17588 C-w} instead. Otherwise, we will run out of `own' keys.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17589
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17590 @need 1250
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17591 Here is another keybinding, with a comment:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17592
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17593 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17594 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17595 ;;; Keybinding for `occur'
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17596 ; I use occur a lot, so let's bind it to a key:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17597 (global-set-key "\C-co" 'occur)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17598 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17599 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17600
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17601 @findex occur
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17602 The @code{occur} command shows all the lines in the current buffer
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17603 that contain a match for a regular expression. Matching lines are
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17604 shown in a buffer called @file{*Occur*}. That buffer serves as a menu
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17605 to jump to occurrences.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17606
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17607 @findex global-unset-key
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17608 @cindex Unbinding key
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17609 @cindex Key unbinding
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17610 @need 1250
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17611 Here is how to unbind a key, so it does not
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17612 work:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17613
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17614 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17615 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17616 ;;; Unbind `C-x f'
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17617 (global-unset-key "\C-xf")
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17618 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17619 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17620
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17621 There is a reason for this unbinding: I found I inadvertently typed
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17622 @w{@kbd{C-x f}} when I meant to type @kbd{C-x C-f}. Rather than find a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17623 file, as I intended, I accidentally set the width for filled text,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17624 almost always to a width I did not want. Since I hardly ever reset my
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17625 default width, I simply unbound the key.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17626
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17627 @findex list-buffers, @r{rebound}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17628 @findex buffer-menu, @r{bound to key}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17629 @need 1250
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17630 The following rebinds an existing key:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17631
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17632 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17633 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17634 ;;; Rebind `C-x C-b' for `buffer-menu'
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17635 (global-set-key "\C-x\C-b" 'buffer-menu)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17636 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17637 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17638
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17639 By default, @kbd{C-x C-b} runs the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17640 @code{list-buffers} command. This command lists
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17641 your buffers in @emph{another} window. Since I
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17642 almost always want to do something in that
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17643 window, I prefer the @code{buffer-menu}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17644 command, which not only lists the buffers,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17645 but moves point into that window.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17646
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17647 @node Keymaps, Loading Files, Keybindings, Emacs Initialization
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17648 @section Keymaps
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17649 @cindex Keymaps
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17650 @cindex Rebinding keys
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17651
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17652 Emacs uses @dfn{keymaps} to record which keys call which commands.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17653 When you use @code{global-set-key} to set the keybinding for a single
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17654 command in all parts of Emacs, you are specifying the keybinding in
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17655 @code{current-global-map}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17656
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17657 Specific modes, such as C mode or Text mode, have their own keymaps;
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17658 the mode-specific keymaps override the global map that is shared by
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17659 all buffers.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17660
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17661 The @code{global-set-key} function binds, or rebinds, the global
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17662 keymap. For example, the following binds the key @kbd{C-x C-b} to the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17663 function @code{buffer-menu}:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17664
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17665 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17666 (global-set-key "\C-x\C-b" 'buffer-menu)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17667 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17668
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17669 Mode-specific keymaps are bound using the @code{define-key} function,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17670 which takes a specific keymap as an argument, as well as the key and
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17671 the command. For example, my @file{.emacs} file contains the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17672 following expression to bind the @code{texinfo-insert-@@group} command
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17673 to @kbd{C-c C-c g}:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17674
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17675 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17676 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17677 (define-key texinfo-mode-map "\C-c\C-cg" 'texinfo-insert-@@group)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17678 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17679 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17680
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17681 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17682 The @code{texinfo-insert-@@group} function itself is a little extension
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17683 to Texinfo mode that inserts @samp{@@group} into a Texinfo file. I
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17684 use this command all the time and prefer to type the three strokes
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17685 @kbd{C-c C-c g} rather than the six strokes @kbd{@@ g r o u p}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17686 (@samp{@@group} and its matching @samp{@@end group} are commands that
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17687 keep all enclosed text together on one page; many multi-line examples
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17688 in this book are surrounded by @samp{@@group @dots{} @@end group}.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17689
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17690 @need 1250
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17691 Here is the @code{texinfo-insert-@@group} function definition:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17692
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17693 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17694 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17695 (defun texinfo-insert-@@group ()
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17696 "Insert the string @@group in a Texinfo buffer."
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17697 (interactive)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17698 (beginning-of-line)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17699 (insert "@@group\n"))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17700 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17701 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17702
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17703 (Of course, I could have used Abbrev mode to save typing, rather than
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17704 write a function to insert a word; but I prefer key strokes consistent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17705 with other Texinfo mode key bindings.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17706
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17707 You will see numerous @code{define-key} expressions in
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17708 @file{loaddefs.el} as well as in the various mode libraries, such as
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17709 @file{cc-mode.el} and @file{lisp-mode.el}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17710
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17711 @xref{Key Bindings, , Customizing Key Bindings, emacs, The GNU Emacs
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17712 Manual}, and @ref{Keymaps, , Keymaps, elisp, The GNU Emacs Lisp
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17713 Reference Manual}, for more information about keymaps.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17714
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17715 @node Loading Files, Autoload, Keymaps, Emacs Initialization
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17716 @section Loading Files
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17717 @cindex Loading files
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17718 @c findex load
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17719
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17720 Many people in the GNU Emacs community have written extensions to
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17721 Emacs. As time goes by, these extensions are often included in new
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17722 releases. For example, the Calendar and Diary packages are now part
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17723 of the standard GNU Emacs, as is Calc.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17724
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17725 You can use a @code{load} command to evaluate a complete file and
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17726 thereby install all the functions and variables in the file into Emacs.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17727 For example:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17728
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17729 @c (auto-compression-mode t)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17730
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17731 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17732 (load "~/emacs/slowsplit")
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17733 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17734
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17735 This evaluates, i.e.@: loads, the @file{slowsplit.el} file or if it
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17736 exists, the faster, byte compiled @file{slowsplit.elc} file from the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17737 @file{emacs} sub-directory of your home directory. The file contains
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17738 the function @code{split-window-quietly}, which John Robinson wrote in
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17739 1989.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17740
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17741 The @code{split-window-quietly} function splits a window with the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17742 minimum of redisplay. I installed it in 1989 because it worked well
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17743 with the slow 1200 baud terminals I was then using. Nowadays, I only
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17744 occasionally come across such a slow connection, but I continue to use
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17745 the function because I like the way it leaves the bottom half of a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17746 buffer in the lower of the new windows and the top half in the upper
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17747 window.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17748
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17749 @need 1250
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17750 To replace the key binding for the default
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17751 @code{split-window-vertically}, you must also unset that key and bind
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17752 the keys to @code{split-window-quietly}, like this:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17753
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17754 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17755 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17756 (global-unset-key "\C-x2")
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17757 (global-set-key "\C-x2" 'split-window-quietly)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17758 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17759 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17760
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17761 @vindex load-path
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17762 If you load many extensions, as I do, then instead of specifying the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17763 exact location of the extension file, as shown above, you can specify
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17764 that directory as part of Emacs' @code{load-path}. Then, when Emacs
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17765 loads a file, it will search that directory as well as its default
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17766 list of directories. (The default list is specified in @file{paths.h}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17767 when Emacs is built.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17768
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17769 @need 1250
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17770 The following command adds your @file{~/emacs} directory to the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17771 existing load path:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17772
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17773 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17774 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17775 ;;; Emacs Load Path
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17776 (setq load-path (cons "~/emacs" load-path))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17777 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17778 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17779
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17780 Incidentally, @code{load-library} is an interactive interface to the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17781 @code{load} function. The complete function looks like this:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17782
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17783 @findex load-library
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17784 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17785 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17786 (defun load-library (library)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17787 "Load the library named LIBRARY.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17788 This is an interface to the function `load'."
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17789 (interactive
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17790 (list (completing-read "Load library: "
94188
6daf76264055 Update example of complex interactive spec.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 88088
diff changeset
17791 (apply-partially 'locate-file-completion-table
6daf76264055 Update example of complex interactive spec.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 88088
diff changeset
17792 load-path
6daf76264055 Update example of complex interactive spec.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 88088
diff changeset
17793 (get-load-suffixes)))))
83955
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17794 (load library))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17795 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17796 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17797
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17798 The name of the function, @code{load-library}, comes from the use of
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17799 `library' as a conventional synonym for `file'. The source for the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17800 @code{load-library} command is in the @file{files.el} library.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17801
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17802 Another interactive command that does a slightly different job is
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17803 @code{load-file}. @xref{Lisp Libraries, , Libraries of Lisp Code for
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17804 Emacs, emacs, The GNU Emacs Manual}, for information on the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17805 distinction between @code{load-library} and this command.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17806
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17807 @node Autoload, Simple Extension, Loading Files, Emacs Initialization
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17808 @section Autoloading
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17809 @findex autoload
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17810
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17811 Instead of installing a function by loading the file that contains it,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17812 or by evaluating the function definition, you can make the function
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17813 available but not actually install it until it is first called. This
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17814 is called @dfn{autoloading}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17815
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17816 When you execute an autoloaded function, Emacs automatically evaluates
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17817 the file that contains the definition, and then calls the function.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17818
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17819 Emacs starts quicker with autoloaded functions, since their libraries
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17820 are not loaded right away; but you need to wait a moment when you
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17821 first use such a function, while its containing file is evaluated.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17822
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17823 Rarely used functions are frequently autoloaded. The
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17824 @file{loaddefs.el} library contains hundreds of autoloaded functions,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17825 from @code{bookmark-set} to @code{wordstar-mode}. Of course, you may
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17826 come to use a `rare' function frequently. When you do, you should
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17827 load that function's file with a @code{load} expression in your
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17828 @file{.emacs} file.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17829
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17830 In my @file{.emacs} file, I load 14 libraries that contain functions
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17831 that would otherwise be autoloaded. (Actually, it would have been
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17832 better to include these files in my `dumped' Emacs, but I forgot.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17833 @xref{Building Emacs, , Building Emacs, elisp, The GNU Emacs Lisp
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17834 Reference Manual}, and the @file{INSTALL} file for more about
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17835 dumping.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17836
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17837 You may also want to include autoloaded expressions in your @file{.emacs}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17838 file. @code{autoload} is a built-in function that takes up to five
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17839 arguments, the final three of which are optional. The first argument
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17840 is the name of the function to be autoloaded; the second is the name
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17841 of the file to be loaded. The third argument is documentation for the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17842 function, and the fourth tells whether the function can be called
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17843 interactively. The fifth argument tells what type of
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17844 object---@code{autoload} can handle a keymap or macro as well as a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17845 function (the default is a function).
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17846
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17847 @need 800
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17848 Here is a typical example:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17849
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17850 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17851 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17852 (autoload 'html-helper-mode
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17853 "html-helper-mode" "Edit HTML documents" t)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17854 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17855 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17856
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17857 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17858 (@code{html-helper-mode} is an older alternative to @code{html-mode},
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17859 which is a standard part of the distribution.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17860
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17861 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17862 This expression autoloads the @code{html-helper-mode} function. It
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17863 takes it from the @file{html-helper-mode.el} file (or from the byte
98525
b6395ec3de45 formatting fixes for new printed edition
Karl Berry <karl@gnu.org>
parents: 94896
diff changeset
17864 compiled version @file{html-helper-mode.elc}, if that exists.) The
b6395ec3de45 formatting fixes for new printed edition
Karl Berry <karl@gnu.org>
parents: 94896
diff changeset
17865 file must be located in a directory specified by @code{load-path}.
b6395ec3de45 formatting fixes for new printed edition
Karl Berry <karl@gnu.org>
parents: 94896
diff changeset
17866 The documentation says that this is a mode to help you edit documents
83955
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17867 written in the HyperText Markup Language. You can call this mode
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17868 interactively by typing @kbd{M-x html-helper-mode}. (You need to
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17869 duplicate the function's regular documentation in the autoload
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17870 expression because the regular function is not yet loaded, so its
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17871 documentation is not available.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17872
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17873 @xref{Autoload, , Autoload, elisp, The GNU Emacs Lisp Reference
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17874 Manual}, for more information.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17875
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17876 @node Simple Extension, X11 Colors, Autoload, Emacs Initialization
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17877 @section A Simple Extension: @code{line-to-top-of-window}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17878 @findex line-to-top-of-window
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17879 @cindex Simple extension in @file{.emacs} file
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17880
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17881 Here is a simple extension to Emacs that moves the line point is on to
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17882 the top of the window. I use this all the time, to make text easier
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17883 to read.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17884
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17885 You can put the following code into a separate file and then load it
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17886 from your @file{.emacs} file, or you can include it within your
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17887 @file{.emacs} file.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17888
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17889 @need 1250
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17890 Here is the definition:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17891
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17892 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17893 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17894 ;;; Line to top of window;
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17895 ;;; replace three keystroke sequence C-u 0 C-l
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17896 (defun line-to-top-of-window ()
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17897 "Move the line point is on to top of window."
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17898 (interactive)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17899 (recenter 0))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17900 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17901 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17902
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17903 @need 1250
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17904 Now for the keybinding.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17905
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17906 Nowadays, function keys as well as mouse button events and
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17907 non-@sc{ascii} characters are written within square brackets, without
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17908 quotation marks. (In Emacs version 18 and before, you had to write
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17909 different function key bindings for each different make of terminal.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17910
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17911 I bind @code{line-to-top-of-window} to my @key{F6} function key like
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17912 this:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17913
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17914 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17915 (global-set-key [f6] 'line-to-top-of-window)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17916 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17917
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17918 For more information, see @ref{Init Rebinding, , Rebinding Keys in
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17919 Your Init File, emacs, The GNU Emacs Manual}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17920
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17921 @cindex Conditional 'twixt two versions of Emacs
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17922 @cindex Version of Emacs, choosing
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17923 @cindex Emacs version, choosing
104095
5b0ac40cc7c1 * emacs-lisp-intro.texi (Simple Extension): Bump emacs versions in
Chong Yidong <cyd@stupidchicken.com>
parents: 103818
diff changeset
17924 If you run two versions of GNU Emacs, such as versions 22 and 23, and
83955
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17925 use one @file{.emacs} file, you can select which code to evaluate with
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17926 the following conditional:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17927
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17928 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17929 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17930 (cond
104095
5b0ac40cc7c1 * emacs-lisp-intro.texi (Simple Extension): Bump emacs versions in
Chong Yidong <cyd@stupidchicken.com>
parents: 103818
diff changeset
17931 ((= 22 emacs-major-version)
5b0ac40cc7c1 * emacs-lisp-intro.texi (Simple Extension): Bump emacs versions in
Chong Yidong <cyd@stupidchicken.com>
parents: 103818
diff changeset
17932 ;; evaluate version 22 code
83955
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17933 ( @dots{} ))
104095
5b0ac40cc7c1 * emacs-lisp-intro.texi (Simple Extension): Bump emacs versions in
Chong Yidong <cyd@stupidchicken.com>
parents: 103818
diff changeset
17934 ((= 23 emacs-major-version)
5b0ac40cc7c1 * emacs-lisp-intro.texi (Simple Extension): Bump emacs versions in
Chong Yidong <cyd@stupidchicken.com>
parents: 103818
diff changeset
17935 ;; evaluate version 23 code
83955
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17936 ( @dots{} )))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17937 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17938 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17939
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17940 For example, in contrast to version 20, more recent versions blink
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17941 their cursors by default. I hate such blinking, as well as other
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17942 features, so I placed the following in my @file{.emacs}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17943 file@footnote{When I start instances of Emacs that do not load my
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17944 @file{.emacs} file or any site file, I also turn off blinking:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17945
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17946 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17947 emacs -q --no-site-file -eval '(blink-cursor-mode nil)'
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17948
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17949 @exdent Or nowadays, using an even more sophisticated set of options,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17950
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17951 emacs -Q - D
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17952 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17953 }:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17954
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17955 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17956 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17957 (when (>= emacs-major-version 21)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17958 (blink-cursor-mode 0)
104095
5b0ac40cc7c1 * emacs-lisp-intro.texi (Simple Extension): Bump emacs versions in
Chong Yidong <cyd@stupidchicken.com>
parents: 103818
diff changeset
17959 ;; Insert newline when you press `C-n' (next-line)
5b0ac40cc7c1 * emacs-lisp-intro.texi (Simple Extension): Bump emacs versions in
Chong Yidong <cyd@stupidchicken.com>
parents: 103818
diff changeset
17960 ;; at the end of the buffer
5b0ac40cc7c1 * emacs-lisp-intro.texi (Simple Extension): Bump emacs versions in
Chong Yidong <cyd@stupidchicken.com>
parents: 103818
diff changeset
17961 (setq next-line-add-newlines t)
5b0ac40cc7c1 * emacs-lisp-intro.texi (Simple Extension): Bump emacs versions in
Chong Yidong <cyd@stupidchicken.com>
parents: 103818
diff changeset
17962 @end group
5b0ac40cc7c1 * emacs-lisp-intro.texi (Simple Extension): Bump emacs versions in
Chong Yidong <cyd@stupidchicken.com>
parents: 103818
diff changeset
17963 @group
5b0ac40cc7c1 * emacs-lisp-intro.texi (Simple Extension): Bump emacs versions in
Chong Yidong <cyd@stupidchicken.com>
parents: 103818
diff changeset
17964 ;; Turn on image viewing
5b0ac40cc7c1 * emacs-lisp-intro.texi (Simple Extension): Bump emacs versions in
Chong Yidong <cyd@stupidchicken.com>
parents: 103818
diff changeset
17965 (auto-image-file-mode t)
5b0ac40cc7c1 * emacs-lisp-intro.texi (Simple Extension): Bump emacs versions in
Chong Yidong <cyd@stupidchicken.com>
parents: 103818
diff changeset
17966 @end group
5b0ac40cc7c1 * emacs-lisp-intro.texi (Simple Extension): Bump emacs versions in
Chong Yidong <cyd@stupidchicken.com>
parents: 103818
diff changeset
17967 @group
5b0ac40cc7c1 * emacs-lisp-intro.texi (Simple Extension): Bump emacs versions in
Chong Yidong <cyd@stupidchicken.com>
parents: 103818
diff changeset
17968 ;; Turn on menu bar (this bar has text)
5b0ac40cc7c1 * emacs-lisp-intro.texi (Simple Extension): Bump emacs versions in
Chong Yidong <cyd@stupidchicken.com>
parents: 103818
diff changeset
17969 ;; (Use numeric argument to turn on)
5b0ac40cc7c1 * emacs-lisp-intro.texi (Simple Extension): Bump emacs versions in
Chong Yidong <cyd@stupidchicken.com>
parents: 103818
diff changeset
17970 (menu-bar-mode 1)
5b0ac40cc7c1 * emacs-lisp-intro.texi (Simple Extension): Bump emacs versions in
Chong Yidong <cyd@stupidchicken.com>
parents: 103818
diff changeset
17971 @end group
5b0ac40cc7c1 * emacs-lisp-intro.texi (Simple Extension): Bump emacs versions in
Chong Yidong <cyd@stupidchicken.com>
parents: 103818
diff changeset
17972 @group
5b0ac40cc7c1 * emacs-lisp-intro.texi (Simple Extension): Bump emacs versions in
Chong Yidong <cyd@stupidchicken.com>
parents: 103818
diff changeset
17973 ;; Turn off tool bar (this bar has icons)
5b0ac40cc7c1 * emacs-lisp-intro.texi (Simple Extension): Bump emacs versions in
Chong Yidong <cyd@stupidchicken.com>
parents: 103818
diff changeset
17974 ;; (Use numeric argument to turn on)
5b0ac40cc7c1 * emacs-lisp-intro.texi (Simple Extension): Bump emacs versions in
Chong Yidong <cyd@stupidchicken.com>
parents: 103818
diff changeset
17975 (tool-bar-mode nil)
5b0ac40cc7c1 * emacs-lisp-intro.texi (Simple Extension): Bump emacs versions in
Chong Yidong <cyd@stupidchicken.com>
parents: 103818
diff changeset
17976 @end group
5b0ac40cc7c1 * emacs-lisp-intro.texi (Simple Extension): Bump emacs versions in
Chong Yidong <cyd@stupidchicken.com>
parents: 103818
diff changeset
17977 @group
5b0ac40cc7c1 * emacs-lisp-intro.texi (Simple Extension): Bump emacs versions in
Chong Yidong <cyd@stupidchicken.com>
parents: 103818
diff changeset
17978 ;; Turn off tooltip mode for tool bar
5b0ac40cc7c1 * emacs-lisp-intro.texi (Simple Extension): Bump emacs versions in
Chong Yidong <cyd@stupidchicken.com>
parents: 103818
diff changeset
17979 ;; (This mode causes icon explanations to pop up)
5b0ac40cc7c1 * emacs-lisp-intro.texi (Simple Extension): Bump emacs versions in
Chong Yidong <cyd@stupidchicken.com>
parents: 103818
diff changeset
17980 ;; (Use numeric argument to turn on)
5b0ac40cc7c1 * emacs-lisp-intro.texi (Simple Extension): Bump emacs versions in
Chong Yidong <cyd@stupidchicken.com>
parents: 103818
diff changeset
17981 (tooltip-mode nil)
5b0ac40cc7c1 * emacs-lisp-intro.texi (Simple Extension): Bump emacs versions in
Chong Yidong <cyd@stupidchicken.com>
parents: 103818
diff changeset
17982 ;; If tooltips turned on, make tips appear promptly
5b0ac40cc7c1 * emacs-lisp-intro.texi (Simple Extension): Bump emacs versions in
Chong Yidong <cyd@stupidchicken.com>
parents: 103818
diff changeset
17983 (setq tooltip-delay 0.1) ; default is 0.7 second
5b0ac40cc7c1 * emacs-lisp-intro.texi (Simple Extension): Bump emacs versions in
Chong Yidong <cyd@stupidchicken.com>
parents: 103818
diff changeset
17984 )
5b0ac40cc7c1 * emacs-lisp-intro.texi (Simple Extension): Bump emacs versions in
Chong Yidong <cyd@stupidchicken.com>
parents: 103818
diff changeset
17985 @end group
5b0ac40cc7c1 * emacs-lisp-intro.texi (Simple Extension): Bump emacs versions in
Chong Yidong <cyd@stupidchicken.com>
parents: 103818
diff changeset
17986 @end smallexample
83955
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17987
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17988 @node X11 Colors, Miscellaneous, Simple Extension, Emacs Initialization
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17989 @section X11 Colors
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17990
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17991 You can specify colors when you use Emacs with the MIT X Windowing
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17992 system.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17993
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17994 I dislike the default colors and specify my own.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17995
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17996 @need 1250
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17997 Here are the expressions in my @file{.emacs}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17998 file that set values:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17999
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18000 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18001 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18002 ;; Set cursor color
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18003 (set-cursor-color "white")
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18004
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18005 ;; Set mouse color
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18006 (set-mouse-color "white")
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18007
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18008 ;; Set foreground and background
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18009 (set-foreground-color "white")
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18010 (set-background-color "darkblue")
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18011 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18012
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18013 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18014 ;;; Set highlighting colors for isearch and drag
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18015 (set-face-foreground 'highlight "white")
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18016 (set-face-background 'highlight "blue")
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18017 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18018
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18019 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18020 (set-face-foreground 'region "cyan")
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18021 (set-face-background 'region "blue")
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18022 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18023
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18024 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18025 (set-face-foreground 'secondary-selection "skyblue")
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18026 (set-face-background 'secondary-selection "darkblue")
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18027 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18028
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18029 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18030 ;; Set calendar highlighting colors
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18031 (setq calendar-load-hook
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18032 '(lambda ()
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18033 (set-face-foreground 'diary-face "skyblue")
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18034 (set-face-background 'holiday-face "slate blue")
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18035 (set-face-foreground 'holiday-face "white")))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18036 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18037 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18038
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18039 The various shades of blue soothe my eye and prevent me from seeing
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18040 the screen flicker.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18041
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18042 Alternatively, I could have set my specifications in various X
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18043 initialization files. For example, I could set the foreground,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18044 background, cursor, and pointer (i.e., mouse) colors in my
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18045 @file{~/.Xresources} file like this:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18046
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18047 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18048 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18049 Emacs*foreground: white
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18050 Emacs*background: darkblue
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18051 Emacs*cursorColor: white
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18052 Emacs*pointerColor: white
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18053 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18054 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18055
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18056 In any event, since it is not part of Emacs, I set the root color of
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18057 my X window in my @file{~/.xinitrc} file, like this@footnote{I also
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18058 run more modern window managers, such as Enlightenment, Gnome, or KDE;
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18059 in those cases, I often specify an image rather than a plain color.}:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18060
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18061 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18062 xsetroot -solid Navy -fg white &
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18063 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18064
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18065 @need 1700
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18066 @node Miscellaneous, Mode Line, X11 Colors, Emacs Initialization
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18067 @section Miscellaneous Settings for a @file{.emacs} File
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18068
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18069 @need 1250
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18070 Here are a few miscellaneous settings:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18071 @sp 1
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18072
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18073 @itemize @minus
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18074 @item
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18075 Set the shape and color of the mouse cursor:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18076
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18077 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18078 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18079 ; Cursor shapes are defined in
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18080 ; `/usr/include/X11/cursorfont.h';
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18081 ; for example, the `target' cursor is number 128;
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18082 ; the `top_left_arrow' cursor is number 132.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18083 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18084
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18085 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18086 (let ((mpointer (x-get-resource "*mpointer"
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18087 "*emacs*mpointer")))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18088 ;; If you have not set your mouse pointer
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18089 ;; then set it, otherwise leave as is:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18090 (if (eq mpointer nil)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18091 (setq mpointer "132")) ; top_left_arrow
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18092 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18093 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18094 (setq x-pointer-shape (string-to-int mpointer))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18095 (set-mouse-color "white"))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18096 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18097 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18098
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18099 @item
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18100 Or you can set the values of a variety of features in an alist, like
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18101 this:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18102
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18103 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18104 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18105 (setq-default
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18106 default-frame-alist
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18107 '((cursor-color . "white")
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18108 (mouse-color . "white")
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18109 (foreground-color . "white")
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18110 (background-color . "DodgerBlue4")
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18111 ;; (cursor-type . bar)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18112 (cursor-type . box)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18113 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18114 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18115 (tool-bar-lines . 0)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18116 (menu-bar-lines . 1)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18117 (width . 80)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18118 (height . 58)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18119 (font .
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18120 "-Misc-Fixed-Medium-R-Normal--20-200-75-75-C-100-ISO8859-1")
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18121 ))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18122 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18123 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18124
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18125 @item
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18126 Convert @kbd{@key{CTRL}-h} into @key{DEL} and @key{DEL}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18127 into @kbd{@key{CTRL}-h}.@*
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18128 (Some older keyboards needed this, although I have not seen the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18129 problem recently.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18130
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18131 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18132 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18133 ;; Translate `C-h' to <DEL>.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18134 ; (keyboard-translate ?\C-h ?\C-?)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18135
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18136 ;; Translate <DEL> to `C-h'.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18137 (keyboard-translate ?\C-? ?\C-h)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18138 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18139 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18140
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18141 @item Turn off a blinking cursor!
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18142
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18143 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18144 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18145 (if (fboundp 'blink-cursor-mode)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18146 (blink-cursor-mode -1))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18147 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18148 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18149
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18150 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18151 or start GNU Emacs with the command @code{emacs -nbc}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18152
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18153 @need 1250
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18154 @item When using `grep'@*
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18155 @samp{-i}@w{ } Ignore case distinctions@*
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18156 @samp{-n}@w{ } Prefix each line of output with line number@*
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18157 @samp{-H}@w{ } Print the filename for each match.@*
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18158 @samp{-e}@w{ } Protect patterns beginning with a hyphen character, @samp{-}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18159
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18160 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18161 (setq grep-command "grep -i -nH -e ")
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18162 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18163
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18164 @ignore
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18165 @c Evidently, no longer needed in GNU Emacs 22
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18166
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18167 item Automatically uncompress compressed files when visiting them
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18168
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18169 smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18170 (load "uncompress")
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18171 end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18172
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18173 @end ignore
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18174
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18175 @item Find an existing buffer, even if it has a different name@*
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18176 This avoids problems with symbolic links.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18177
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18178 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18179 (setq find-file-existing-other-name t)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18180 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18181
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18182 @item Set your language environment and default input method
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18183
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18184 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18185 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18186 (set-language-environment "latin-1")
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18187 ;; Remember you can enable or disable multilingual text input
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18188 ;; with the @code{toggle-input-method'} (@kbd{C-\}) command
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18189 (setq default-input-method "latin-1-prefix")
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18190 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18191 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18192
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18193 If you want to write with Chinese `GB' characters, set this instead:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18194
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18195 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18196 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18197 (set-language-environment "Chinese-GB")
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18198 (setq default-input-method "chinese-tonepy")
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18199 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18200 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18201 @end itemize
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18202
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18203 @subsubheading Fixing Unpleasant Key Bindings
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18204 @cindex Key bindings, fixing
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18205 @cindex Bindings, key, fixing unpleasant
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18206
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18207 Some systems bind keys unpleasantly. Sometimes, for example, the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18208 @key{CTRL} key appears in an awkward spot rather than at the far left
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18209 of the home row.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18210
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18211 Usually, when people fix these sorts of keybindings, they do not
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18212 change their @file{~/.emacs} file. Instead, they bind the proper keys
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18213 on their consoles with the @code{loadkeys} or @code{install-keymap}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18214 commands in their boot script and then include @code{xmodmap} commands
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18215 in their @file{.xinitrc} or @file{.Xsession} file for X Windows.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18216
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18217 @need 1250
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18218 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18219 For a boot script:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18220
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18221 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18222 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18223 loadkeys /usr/share/keymaps/i386/qwerty/emacs2.kmap.gz
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18224 @exdent or
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18225 install-keymap emacs2
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18226 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18227 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18228
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18229 @need 1250
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18230 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18231 For a @file{.xinitrc} or @file{.Xsession} file when the @key{Caps
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18232 Lock} key is at the far left of the home row:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18233
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18234 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18235 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18236 # Bind the key labeled `Caps Lock' to `Control'
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18237 # (Such a broken user interface suggests that keyboard manufacturers
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18238 # think that computers are typewriters from 1885.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18239
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18240 xmodmap -e "clear Lock"
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18241 xmodmap -e "add Control = Caps_Lock"
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18242 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18243 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18244
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18245 @need 1250
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18246 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18247 In a @file{.xinitrc} or @file{.Xsession} file, to convert an @key{ALT}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18248 key to a @key{META} key:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18249
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18250 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18251 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18252 # Some ill designed keyboards have a key labeled ALT and no Meta
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18253 xmodmap -e "keysym Alt_L = Meta_L Alt_L"
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18254 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18255 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18256
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18257 @need 1700
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18258 @node Mode Line, , Miscellaneous, Emacs Initialization
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18259 @section A Modified Mode Line
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18260 @vindex default-mode-line-format
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18261 @cindex Mode line format
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18262
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18263 Finally, a feature I really like: a modified mode line.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18264
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18265 When I work over a network, I forget which machine I am using. Also,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18266 I tend to I lose track of where I am, and which line point is on.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18267
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18268 So I reset my mode line to look like this:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18269
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18270 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18271 -:-- foo.texi rattlesnake:/home/bob/ Line 1 (Texinfo Fill) Top
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18272 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18273
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18274 I am visiting a file called @file{foo.texi}, on my machine
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18275 @file{rattlesnake} in my @file{/home/bob} buffer. I am on line 1, in
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18276 Texinfo mode, and am at the top of the buffer.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18277
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18278 @need 1200
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18279 My @file{.emacs} file has a section that looks like this:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18280
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18281 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18282 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18283 ;; Set a Mode Line that tells me which machine, which directory,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18284 ;; and which line I am on, plus the other customary information.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18285 (setq default-mode-line-format
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18286 (quote
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18287 (#("-" 0 1
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18288 (help-echo
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18289 "mouse-1: select window, mouse-2: delete others ..."))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18290 mode-line-mule-info
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18291 mode-line-modified
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18292 mode-line-frame-identification
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18293 " "
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18294 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18295 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18296 mode-line-buffer-identification
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18297 " "
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18298 (:eval (substring
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18299 (system-name) 0 (string-match "\\..+" (system-name))))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18300 ":"
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18301 default-directory
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18302 #(" " 0 1
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18303 (help-echo
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18304 "mouse-1: select window, mouse-2: delete others ..."))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18305 (line-number-mode " Line %l ")
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18306 global-mode-string
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18307 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18308 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18309 #(" %[(" 0 6
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18310 (help-echo
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18311 "mouse-1: select window, mouse-2: delete others ..."))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18312 (:eval (mode-line-mode-name))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18313 mode-line-process
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18314 minor-mode-alist
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18315 #("%n" 0 2 (help-echo "mouse-2: widen" local-map (keymap ...)))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18316 ")%] "
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18317 (-3 . "%P")
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18318 ;; "-%-"
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18319 )))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18320 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18321 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18322
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18323 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18324 Here, I redefine the default mode line. Most of the parts are from
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18325 the original; but I make a few changes. I set the @emph{default} mode
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18326 line format so as to permit various modes, such as Info, to override
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18327 it.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18328
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18329 Many elements in the list are self-explanatory:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18330 @code{mode-line-modified} is a variable that tells whether the buffer
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18331 has been modified, @code{mode-name} tells the name of the mode, and so
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18332 on. However, the format looks complicated because of two features we
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18333 have not discussed.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18334
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18335 @cindex Properties, in mode line example
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18336 The first string in the mode line is a dash or hyphen, @samp{-}. In
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18337 the old days, it would have been specified simply as @code{"-"}. But
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18338 nowadays, Emacs can add properties to a string, such as highlighting
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18339 or, as in this case, a help feature. If you place your mouse cursor
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18340 over the hyphen, some help information appears (By default, you must
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18341 wait seven-tenths of a second before the information appears. You can
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18342 change that timing by changing the value of @code{tooltip-delay}.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18343
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18344 @need 1000
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18345 The new string format has a special syntax:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18346
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18347 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18348 #("-" 0 1 (help-echo "mouse-1: select window, ..."))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18349 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18350
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18351 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18352 The @code{#(} begins a list. The first element of the list is the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18353 string itself, just one @samp{-}. The second and third
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18354 elements specify the range over which the fourth element applies. A
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18355 range starts @emph{after} a character, so a zero means the range
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18356 starts just before the first character; a 1 means that the range ends
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18357 just after the first character. The third element is the property for
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18358 the range. It consists of a property list, a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18359 property name, in this case, @samp{help-echo}, followed by a value, in this
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18360 case, a string. The second, third, and fourth elements of this new
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18361 string format can be repeated.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18362
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18363 @xref{Text Properties, , Text Properties, elisp, The GNU Emacs Lisp
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18364 Reference Manual}, and see @ref{Mode Line Format, , Mode Line Format,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18365 elisp, The GNU Emacs Lisp Reference Manual}, for more information.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18366
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18367 @code{mode-line-buffer-identification}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18368 displays the current buffer name. It is a list
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18369 beginning @code{(#("%12b" 0 4 @dots{}}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18370 The @code{#(} begins the list.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18371
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18372 The @samp{"%12b"} displays the current buffer name, using the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18373 @code{buffer-name} function with which we are familiar; the `12'
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18374 specifies the maximum number of characters that will be displayed.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18375 When a name has fewer characters, whitespace is added to fill out to
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18376 this number. (Buffer names can and often should be longer than 12
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18377 characters; this length works well in a typical 80 column wide
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18378 window.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18379
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18380 @code{:eval} says to evaluate the following form and use the result as
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18381 a string to display. In this case, the expression displays the first
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18382 component of the full system name. The end of the first component is
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18383 a @samp{.} (`period'), so I use the @code{string-match} function to
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18384 tell me the length of the first component. The substring from the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18385 zeroth character to that length is the name of the machine.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18386
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18387 @need 1250
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18388 This is the expression:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18389
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18390 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18391 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18392 (:eval (substring
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18393 (system-name) 0 (string-match "\\..+" (system-name))))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18394 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18395 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18396
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18397 @samp{%[} and @samp{%]} cause a pair of square brackets
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18398 to appear for each recursive editing level. @samp{%n} says `Narrow'
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18399 when narrowing is in effect. @samp{%P} tells you the percentage of
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18400 the buffer that is above the bottom of the window, or `Top', `Bottom',
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18401 or `All'. (A lower case @samp{p} tell you the percentage above the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18402 @emph{top} of the window.) @samp{%-} inserts enough dashes to fill
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18403 out the line.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18404
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18405 Remember, ``You don't have to like Emacs to like it'' --- your own
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18406 Emacs can have different colors, different commands, and different
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18407 keys than a default Emacs.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18408
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18409 On the other hand, if you want to bring up a plain `out of the box'
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18410 Emacs, with no customization, type:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18411
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18412 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18413 emacs -q
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18414 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18415
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18416 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18417 This will start an Emacs that does @emph{not} load your
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18418 @file{~/.emacs} initialization file. A plain, default Emacs. Nothing
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18419 more.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18420
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18421 @node Debugging, Conclusion, Emacs Initialization, Top
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18422 @chapter Debugging
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18423 @cindex debugging
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18424
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18425 GNU Emacs has two debuggers, @code{debug} and @code{edebug}. The
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18426 first is built into the internals of Emacs and is always with you;
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18427 the second requires that you instrument a function before you can use it.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18428
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18429 Both debuggers are described extensively in @ref{Debugging, ,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18430 Debugging Lisp Programs, elisp, The GNU Emacs Lisp Reference Manual}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18431 In this chapter, I will walk through a short example of each.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18432
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18433 @menu
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18434 * debug:: How to use the built-in debugger.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18435 * debug-on-entry:: Start debugging when you call a function.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18436 * debug-on-quit:: Start debugging when you quit with @kbd{C-g}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18437 * edebug:: How to use Edebug, a source level debugger.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18438 * Debugging Exercises::
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18439 @end menu
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18440
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18441 @node debug, debug-on-entry, Debugging, Debugging
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18442 @section @code{debug}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18443 @findex debug
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18444
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18445 Suppose you have written a function definition that is intended to
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18446 return the sum of the numbers 1 through a given number. (This is the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18447 @code{triangle} function discussed earlier. @xref{Decrementing
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18448 Example, , Example with Decrementing Counter}, for a discussion.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18449 @c xref{Decrementing Loop,, Loop with a Decrementing Counter}, for a discussion.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18450
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18451 However, your function definition has a bug. You have mistyped
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18452 @samp{1=} for @samp{1-}. Here is the broken definition:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18453
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18454 @findex triangle-bugged
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18455 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18456 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18457 (defun triangle-bugged (number)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18458 "Return sum of numbers 1 through NUMBER inclusive."
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18459 (let ((total 0))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18460 (while (> number 0)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18461 (setq total (+ total number))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18462 (setq number (1= number))) ; @r{Error here.}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18463 total))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18464 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18465 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18466
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18467 If you are reading this in Info, you can evaluate this definition in
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18468 the normal fashion. You will see @code{triangle-bugged} appear in the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18469 echo area.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18470
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18471 @need 1250
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18472 Now evaluate the @code{triangle-bugged} function with an
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18473 argument of 4:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18474
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18475 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18476 (triangle-bugged 4)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18477 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18478
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18479 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18480 In a recent GNU Emacs, you will create and enter a @file{*Backtrace*}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18481 buffer that says:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18482
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18483 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18484 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18485 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18486 ---------- Buffer: *Backtrace* ----------
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18487 Debugger entered--Lisp error: (void-function 1=)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18488 (1= number)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18489 (setq number (1= number))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18490 (while (> number 0) (setq total (+ total number))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18491 (setq number (1= number)))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18492 (let ((total 0)) (while (> number 0) (setq total ...)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18493 (setq number ...)) total)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18494 triangle-bugged(4)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18495 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18496 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18497 eval((triangle-bugged 4))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18498 eval-last-sexp-1(nil)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18499 eval-last-sexp(nil)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18500 call-interactively(eval-last-sexp)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18501 ---------- Buffer: *Backtrace* ----------
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18502 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18503 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18504
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18505 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18506 (I have reformatted this example slightly; the debugger does not fold
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18507 long lines. As usual, you can quit the debugger by typing @kbd{q} in
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18508 the @file{*Backtrace*} buffer.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18509
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18510 In practice, for a bug as simple as this, the `Lisp error' line will
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18511 tell you what you need to know to correct the definition. The
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18512 function @code{1=} is `void'.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18513
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18514 @ignore
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18515 @need 800
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18516 In GNU Emacs 20 and before, you will see:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18517
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18518 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18519 Symbol's function definition is void:@: 1=
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18520 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18521
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18522 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18523 which has the same meaning as the @file{*Backtrace*} buffer line in
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18524 version 21.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18525 @end ignore
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18526
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18527 However, suppose you are not quite certain what is going on?
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18528 You can read the complete backtrace.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18529
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18530 In this case, you need to run a recent GNU Emacs, which automatically
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18531 starts the debugger that puts you in the @file{*Backtrace*} buffer; or
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18532 else, you need to start the debugger manually as described below.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18533
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18534 Read the @file{*Backtrace*} buffer from the bottom up; it tells you
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18535 what Emacs did that led to the error. Emacs made an interactive call
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18536 to @kbd{C-x C-e} (@code{eval-last-sexp}), which led to the evaluation
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18537 of the @code{triangle-bugged} expression. Each line above tells you
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18538 what the Lisp interpreter evaluated next.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18539
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18540 @need 1250
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18541 The third line from the top of the buffer is
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18542
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18543 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18544 (setq number (1= number))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18545 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18546
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18547 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18548 Emacs tried to evaluate this expression; in order to do so, it tried
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18549 to evaluate the inner expression shown on the second line from the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18550 top:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18551
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18552 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18553 (1= number)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18554 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18555
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18556 @need 1250
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18557 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18558 This is where the error occurred; as the top line says:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18559
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18560 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18561 Debugger entered--Lisp error: (void-function 1=)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18562 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18563
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18564 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18565 You can correct the mistake, re-evaluate the function definition, and
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18566 then run your test again.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18567
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18568 @node debug-on-entry, debug-on-quit, debug, Debugging
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18569 @section @code{debug-on-entry}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18570 @findex debug-on-entry
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18571
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18572 A recent GNU Emacs starts the debugger automatically when your
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18573 function has an error.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18574
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18575 @ignore
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18576 GNU Emacs version 20 and before did not; it simply
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18577 presented you with an error message. You had to start the debugger
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18578 manually.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18579 @end ignore
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18580
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18581 Incidentally, you can start the debugger manually for all versions of
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18582 Emacs; the advantage is that the debugger runs even if you do not have
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18583 a bug in your code. Sometimes your code will be free of bugs!
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18584
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18585 You can enter the debugger when you call the function by calling
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18586 @code{debug-on-entry}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18587
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18588 @need 1250
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18589 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18590 Type:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18591
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18592 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18593 M-x debug-on-entry RET triangle-bugged RET
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18594 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18595
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18596 @need 1250
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18597 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18598 Now, evaluate the following:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18599
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18600 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18601 (triangle-bugged 5)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18602 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18603
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18604 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18605 All versions of Emacs will create a @file{*Backtrace*} buffer and tell
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18606 you that it is beginning to evaluate the @code{triangle-bugged}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18607 function:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18608
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18609 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18610 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18611 ---------- Buffer: *Backtrace* ----------
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18612 Debugger entered--entering a function:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18613 * triangle-bugged(5)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18614 eval((triangle-bugged 5))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18615 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18616 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18617 eval-last-sexp-1(nil)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18618 eval-last-sexp(nil)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18619 call-interactively(eval-last-sexp)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18620 ---------- Buffer: *Backtrace* ----------
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18621 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18622 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18623
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18624 In the @file{*Backtrace*} buffer, type @kbd{d}. Emacs will evaluate
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18625 the first expression in @code{triangle-bugged}; the buffer will look
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18626 like this:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18627
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18628 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18629 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18630 ---------- Buffer: *Backtrace* ----------
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18631 Debugger entered--beginning evaluation of function call form:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18632 * (let ((total 0)) (while (> number 0) (setq total ...)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18633 (setq number ...)) total)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18634 * triangle-bugged(5)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18635 eval((triangle-bugged 5))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18636 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18637 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18638 eval-last-sexp-1(nil)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18639 eval-last-sexp(nil)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18640 call-interactively(eval-last-sexp)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18641 ---------- Buffer: *Backtrace* ----------
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18642 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18643 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18644
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18645 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18646 Now, type @kbd{d} again, eight times, slowly. Each time you type
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18647 @kbd{d}, Emacs will evaluate another expression in the function
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18648 definition.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18649
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18650 @need 1750
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18651 Eventually, the buffer will look like this:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18652
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18653 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18654 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18655 ---------- Buffer: *Backtrace* ----------
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18656 Debugger entered--beginning evaluation of function call form:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18657 * (setq number (1= number))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18658 * (while (> number 0) (setq total (+ total number))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18659 (setq number (1= number)))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18660 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18661 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18662 * (let ((total 0)) (while (> number 0) (setq total ...)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18663 (setq number ...)) total)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18664 * triangle-bugged(5)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18665 eval((triangle-bugged 5))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18666 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18667 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18668 eval-last-sexp-1(nil)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18669 eval-last-sexp(nil)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18670 call-interactively(eval-last-sexp)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18671 ---------- Buffer: *Backtrace* ----------
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18672 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18673 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18674
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18675 @need 1500
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18676 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18677 Finally, after you type @kbd{d} two more times, Emacs will reach the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18678 error, and the top two lines of the @file{*Backtrace*} buffer will look
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18679 like this:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18680
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18681 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18682 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18683 ---------- Buffer: *Backtrace* ----------
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18684 Debugger entered--Lisp error: (void-function 1=)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18685 * (1= number)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18686 @dots{}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18687 ---------- Buffer: *Backtrace* ----------
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18688 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18689 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18690
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18691 By typing @kbd{d}, you were able to step through the function.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18692
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18693 You can quit a @file{*Backtrace*} buffer by typing @kbd{q} in it; this
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18694 quits the trace, but does not cancel @code{debug-on-entry}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18695
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18696 @findex cancel-debug-on-entry
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18697 To cancel the effect of @code{debug-on-entry}, call
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18698 @code{cancel-debug-on-entry} and the name of the function, like this:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18699
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18700 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18701 M-x cancel-debug-on-entry RET triangle-bugged RET
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18702 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18703
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18704 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18705 (If you are reading this in Info, cancel @code{debug-on-entry} now.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18706
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18707 @node debug-on-quit, edebug, debug-on-entry, Debugging
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18708 @section @code{debug-on-quit} and @code{(debug)}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18709
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18710 In addition to setting @code{debug-on-error} or calling @code{debug-on-entry},
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18711 there are two other ways to start @code{debug}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18712
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18713 @findex debug-on-quit
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18714 You can start @code{debug} whenever you type @kbd{C-g}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18715 (@code{keyboard-quit}) by setting the variable @code{debug-on-quit} to
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18716 @code{t}. This is useful for debugging infinite loops.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18717
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18718 @need 1500
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18719 @cindex @code{(debug)} in code
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18720 Or, you can insert a line that says @code{(debug)} into your code
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18721 where you want the debugger to start, like this:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18722
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18723 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18724 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18725 (defun triangle-bugged (number)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18726 "Return sum of numbers 1 through NUMBER inclusive."
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18727 (let ((total 0))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18728 (while (> number 0)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18729 (setq total (+ total number))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18730 (debug) ; @r{Start debugger.}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18731 (setq number (1= number))) ; @r{Error here.}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18732 total))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18733 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18734 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18735
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18736 The @code{debug} function is described in detail in @ref{Debugger, ,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18737 The Lisp Debugger, elisp, The GNU Emacs Lisp Reference Manual}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18738
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18739 @node edebug, Debugging Exercises, debug-on-quit, Debugging
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18740 @section The @code{edebug} Source Level Debugger
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18741 @cindex Source level debugger
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18742 @findex edebug
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18743
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18744 Edebug is a source level debugger. Edebug normally displays the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18745 source of the code you are debugging, with an arrow at the left that
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18746 shows which line you are currently executing.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18747
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18748 You can walk through the execution of a function, line by line, or run
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18749 quickly until reaching a @dfn{breakpoint} where execution stops.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18750
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18751 Edebug is described in @ref{edebug, , Edebug, elisp, The GNU Emacs
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18752 Lisp Reference Manual}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18753
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18754 @need 1250
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18755 Here is a bugged function definition for @code{triangle-recursively}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18756 @xref{Recursive triangle function, , Recursion in place of a counter},
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18757 for a review of it.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18758
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18759 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18760 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18761 (defun triangle-recursively-bugged (number)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18762 "Return sum of numbers 1 through NUMBER inclusive.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18763 Uses recursion."
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18764 (if (= number 1)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18765 1
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18766 (+ number
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18767 (triangle-recursively-bugged
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18768 (1= number))))) ; @r{Error here.}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18769 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18770 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18771
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18772 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18773 Normally, you would install this definition by positioning your cursor
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18774 after the function's closing parenthesis and typing @kbd{C-x C-e}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18775 (@code{eval-last-sexp}) or else by positioning your cursor within the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18776 definition and typing @kbd{C-M-x} (@code{eval-defun}). (By default,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18777 the @code{eval-defun} command works only in Emacs Lisp mode or in Lisp
103421
5ae71ac16ed0 * emacs-lisp-intro.texi (edebug): Fix typo.
Chong Yidong <cyd@stupidchicken.com>
parents: 102187
diff changeset
18778 Interaction mode.)
83955
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18779
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18780 @need 1500
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18781 However, to prepare this function definition for Edebug, you must
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18782 first @dfn{instrument} the code using a different command. You can do
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18783 this by positioning your cursor within or just after the definition
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18784 and typing
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18785
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18786 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18787 M-x edebug-defun RET
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18788 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18789
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18790 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18791 This will cause Emacs to load Edebug automatically if it is not
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18792 already loaded, and properly instrument the function.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18793
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18794 After instrumenting the function, place your cursor after the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18795 following expression and type @kbd{C-x C-e} (@code{eval-last-sexp}):
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18796
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18797 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18798 (triangle-recursively-bugged 3)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18799 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18800
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18801 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18802 You will be jumped back to the source for
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18803 @code{triangle-recursively-bugged} and the cursor positioned at the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18804 beginning of the @code{if} line of the function. Also, you will see
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18805 an arrowhead at the left hand side of that line. The arrowhead marks
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18806 the line where the function is executing. (In the following examples,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18807 we show the arrowhead with @samp{=>}; in a windowing system, you may
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18808 see the arrowhead as a solid triangle in the window `fringe'.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18809
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18810 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18811 =>@point{}(if (= number 1)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18812 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18813
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18814 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18815 @iftex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18816 In the example, the location of point is displayed with a star,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18817 @samp{@point{}} (in Info, it is displayed as @samp{-!-}).
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18818 @end iftex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18819 @ifnottex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18820 In the example, the location of point is displayed as @samp{@point{}}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18821 (in a printed book, it is displayed with a five pointed star).
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18822 @end ifnottex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18823
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18824 If you now press @key{SPC}, point will move to the next expression to
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18825 be executed; the line will look like this:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18826
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18827 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18828 =>(if @point{}(= number 1)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18829 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18830
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18831 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18832 As you continue to press @key{SPC}, point will move from expression to
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18833 expression. At the same time, whenever an expression returns a value,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18834 that value will be displayed in the echo area. For example, after you
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18835 move point past @code{number}, you will see the following:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18836
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18837 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18838 Result: 3 (#o3, #x3, ?\C-c)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18839 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18840
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18841 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18842 This means the value of @code{number} is 3, which is octal three,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18843 hexadecimal three, and @sc{ascii} `control-c' (the third letter of the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18844 alphabet, in case you need to know this information).
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18845
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18846 You can continue moving through the code until you reach the line with
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18847 the error. Before evaluation, that line looks like this:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18848
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18849 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18850 => @point{}(1= number))))) ; @r{Error here.}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18851 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18852
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18853 @need 1250
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18854 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18855 When you press @key{SPC} once again, you will produce an error message
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18856 that says:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18857
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18858 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18859 Symbol's function definition is void:@: 1=
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18860 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18861
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18862 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18863 This is the bug.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18864
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18865 Press @kbd{q} to quit Edebug.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18866
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18867 To remove instrumentation from a function definition, simply
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18868 re-evaluate it with a command that does not instrument it.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18869 For example, you could place your cursor after the definition's
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18870 closing parenthesis and type @kbd{C-x C-e}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18871
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18872 Edebug does a great deal more than walk with you through a function.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18873 You can set it so it races through on its own, stopping only at an
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18874 error or at specified stopping points; you can cause it to display the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18875 changing values of various expressions; you can find out how many
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18876 times a function is called, and more.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18877
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18878 Edebug is described in @ref{edebug, , Edebug, elisp, The GNU Emacs
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18879 Lisp Reference Manual}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18880
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18881 @need 1500
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18882 @node Debugging Exercises, , edebug, Debugging
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18883 @section Debugging Exercises
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18884
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18885 @itemize @bullet
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18886 @item
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18887 Install the @code{count-words-region} function and then cause it to
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18888 enter the built-in debugger when you call it. Run the command on a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18889 region containing two words. You will need to press @kbd{d} a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18890 remarkable number of times. On your system, is a `hook' called after
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18891 the command finishes? (For information on hooks, see @ref{Command
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18892 Overview, , Command Loop Overview, elisp, The GNU Emacs Lisp Reference
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18893 Manual}.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18894
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18895 @item
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18896 Copy @code{count-words-region} into the @file{*scratch*} buffer,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18897 instrument the function for Edebug, and walk through its execution.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18898 The function does not need to have a bug, although you can introduce
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18899 one if you wish. If the function lacks a bug, the walk-through
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18900 completes without problems.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18901
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18902 @item
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18903 While running Edebug, type @kbd{?} to see a list of all the Edebug commands.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18904 (The @code{global-edebug-prefix} is usually @kbd{C-x X}, i.e.@:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18905 @kbd{@key{CTRL}-x} followed by an upper case @kbd{X}; use this prefix
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18906 for commands made outside of the Edebug debugging buffer.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18907
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18908 @item
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18909 In the Edebug debugging buffer, use the @kbd{p}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18910 (@code{edebug-bounce-point}) command to see where in the region the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18911 @code{count-words-region} is working.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18912
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18913 @item
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18914 Move point to some spot further down the function and then type the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18915 @kbd{h} (@code{edebug-goto-here}) command to jump to that location.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18916
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18917 @item
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18918 Use the @kbd{t} (@code{edebug-trace-mode}) command to cause Edebug to
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18919 walk through the function on its own; use an upper case @kbd{T} for
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18920 @code{edebug-Trace-fast-mode}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18921
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18922 @item
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18923 Set a breakpoint, then run Edebug in Trace mode until it reaches the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18924 stopping point.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18925 @end itemize
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18926
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18927 @node Conclusion, the-the, Debugging, Top
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18928 @chapter Conclusion
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18929
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18930 We have now reached the end of this Introduction. You have now
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18931 learned enough about programming in Emacs Lisp to set values, to write
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18932 simple @file{.emacs} files for yourself and your friends, and write
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18933 simple customizations and extensions to Emacs.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18934
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18935 This is a place to stop. Or, if you wish, you can now go onward, and
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18936 teach yourself.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18937
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18938 You have learned some of the basic nuts and bolts of programming. But
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18939 only some. There are a great many more brackets and hinges that are
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18940 easy to use that we have not touched.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18941
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18942 A path you can follow right now lies among the sources to GNU Emacs
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18943 and in
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18944 @ifnotinfo
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18945 @cite{The GNU Emacs Lisp Reference Manual}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18946 @end ifnotinfo
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18947 @ifinfo
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18948 @ref{Top, , The GNU Emacs Lisp Reference Manual, elisp, The GNU
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18949 Emacs Lisp Reference Manual}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18950 @end ifinfo
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18951
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18952 The Emacs Lisp sources are an adventure. When you read the sources and
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18953 come across a function or expression that is unfamiliar, you need to
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18954 figure out or find out what it does.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18955
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18956 Go to the Reference Manual. It is a thorough, complete, and fairly
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18957 easy-to-read description of Emacs Lisp. It is written not only for
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18958 experts, but for people who know what you know. (The @cite{Reference
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18959 Manual} comes with the standard GNU Emacs distribution. Like this
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18960 introduction, it comes as a Texinfo source file, so you can read it
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18961 on-line and as a typeset, printed book.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18962
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18963 Go to the other on-line help that is part of GNU Emacs: the on-line
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18964 documentation for all functions and variables, and @code{find-tags},
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18965 the program that takes you to sources.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18966
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18967 Here is an example of how I explore the sources. Because of its name,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18968 @file{simple.el} is the file I looked at first, a long time ago. As
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18969 it happens some of the functions in @file{simple.el} are complicated,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18970 or at least look complicated at first sight. The @code{open-line}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18971 function, for example, looks complicated.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18972
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18973 You may want to walk through this function slowly, as we did with the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18974 @code{forward-sentence} function. (@xref{forward-sentence, The
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18975 @code{forward-sentence} function}.) Or you may want to skip that
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18976 function and look at another, such as @code{split-line}. You don't
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18977 need to read all the functions. According to
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18978 @code{count-words-in-defun}, the @code{split-line} function contains
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18979 102 words and symbols.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18980
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18981 Even though it is short, @code{split-line} contains expressions
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18982 we have not studied: @code{skip-chars-forward}, @code{indent-to},
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18983 @code{current-column} and @code{insert-and-inherit}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18984
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18985 Consider the @code{skip-chars-forward} function. (It is part of the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18986 function definition for @code{back-to-indentation}, which is shown in
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18987 @ref{Review, , Review}.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18988
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18989 In GNU Emacs, you can find out more about @code{skip-chars-forward} by
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18990 typing @kbd{C-h f} (@code{describe-function}) and the name of the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18991 function. This gives you the function documentation.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18992
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18993 You may be able to guess what is done by a well named function such as
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18994 @code{indent-to}; or you can look it up, too. Incidentally, the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18995 @code{describe-function} function itself is in @file{help.el}; it is
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18996 one of those long, but decipherable functions. You can look up
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18997 @code{describe-function} using the @kbd{C-h f} command!
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18998
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18999 In this instance, since the code is Lisp, the @file{*Help*} buffer
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19000 contains the name of the library containing the function's source.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19001 You can put point over the name of the library and press the RET key,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19002 which in this situation is bound to @code{help-follow}, and be taken
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19003 directly to the source, in the same way as @kbd{M-.}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19004 (@code{find-tag}).
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19005
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19006 The definition for @code{describe-function} illustrates how to
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19007 customize the @code{interactive} expression without using the standard
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19008 character codes; and it shows how to create a temporary buffer.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19009
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19010 (The @code{indent-to} function is written in C rather than Emacs Lisp;
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19011 it is a `built-in' function. @code{help-follow} takes you to its
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19012 source as does @code{find-tag}, when properly set up.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19013
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19014 You can look at a function's source using @code{find-tag}, which is
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19015 bound to @kbd{M-.} Finally, you can find out what the Reference
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19016 Manual has to say by visiting the manual in Info, and typing @kbd{i}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19017 (@code{Info-index}) and the name of the function, or by looking up the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19018 function in the index to a printed copy of the manual.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19019
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19020 Similarly, you can find out what is meant by
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19021 @code{insert-and-inherit}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19022
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19023 Other interesting source files include @file{paragraphs.el},
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19024 @file{loaddefs.el}, and @file{loadup.el}. The @file{paragraphs.el}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19025 file includes short, easily understood functions as well as longer
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19026 ones. The @file{loaddefs.el} file contains the many standard
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19027 autoloads and many keymaps. I have never looked at it all; only at
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19028 parts. @file{loadup.el} is the file that loads the standard parts of
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19029 Emacs; it tells you a great deal about how Emacs is built.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19030 (@xref{Building Emacs, , Building Emacs, elisp, The GNU Emacs Lisp
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19031 Reference Manual}, for more about building.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19032
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19033 As I said, you have learned some nuts and bolts; however, and very
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19034 importantly, we have hardly touched major aspects of programming; I
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19035 have said nothing about how to sort information, except to use the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19036 predefined @code{sort} function; I have said nothing about how to store
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19037 information, except to use variables and lists; I have said nothing
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19038 about how to write programs that write programs. These are topics for
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19039 another, and different kind of book, a different kind of learning.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19040
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19041 What you have done is learn enough for much practical work with GNU
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19042 Emacs. What you have done is get started. This is the end of a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19043 beginning.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19044
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19045 @c ================ Appendix ================
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19046
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19047 @node the-the, Kill Ring, Conclusion, Top
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19048 @appendix The @code{the-the} Function
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19049 @findex the-the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19050 @cindex Duplicated words function
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19051 @cindex Words, duplicated
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19052
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19053 Sometimes when you you write text, you duplicate words---as with ``you
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19054 you'' near the beginning of this sentence. I find that most
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19055 frequently, I duplicate ``the''; hence, I call the function for
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19056 detecting duplicated words, @code{the-the}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19057
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19058 @need 1250
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19059 As a first step, you could use the following regular expression to
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19060 search for duplicates:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19061
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19062 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19063 \\(\\w+[ \t\n]+\\)\\1
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19064 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19065
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19066 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19067 This regexp matches one or more word-constituent characters followed
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19068 by one or more spaces, tabs, or newlines. However, it does not detect
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19069 duplicated words on different lines, since the ending of the first
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19070 word, the end of the line, is different from the ending of the second
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19071 word, a space. (For more information about regular expressions, see
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19072 @ref{Regexp Search, , Regular Expression Searches}, as well as
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19073 @ref{Regexps, , Syntax of Regular Expressions, emacs, The GNU Emacs
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19074 Manual}, and @ref{Regular Expressions, , Regular Expressions, elisp,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19075 The GNU Emacs Lisp Reference Manual}.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19076
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19077 You might try searching just for duplicated word-constituent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19078 characters but that does not work since the pattern detects doubles
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19079 such as the two occurrences of `th' in `with the'.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19080
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19081 Another possible regexp searches for word-constituent characters
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19082 followed by non-word-constituent characters, reduplicated. Here,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19083 @w{@samp{\\w+}} matches one or more word-constituent characters and
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19084 @w{@samp{\\W*}} matches zero or more non-word-constituent characters.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19085
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19086 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19087 \\(\\(\\w+\\)\\W*\\)\\1
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19088 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19089
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19090 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19091 Again, not useful.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19092
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19093 Here is the pattern that I use. It is not perfect, but good enough.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19094 @w{@samp{\\b}} matches the empty string, provided it is at the beginning
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19095 or end of a word; @w{@samp{[^@@ \n\t]+}} matches one or more occurrences of
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19096 any characters that are @emph{not} an @@-sign, space, newline, or tab.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19097
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19098 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19099 \\b\\([^@@ \n\t]+\\)[ \n\t]+\\1\\b
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19100 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19101
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19102 One can write more complicated expressions, but I found that this
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19103 expression is good enough, so I use it.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19104
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19105 Here is the @code{the-the} function, as I include it in my
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19106 @file{.emacs} file, along with a handy global key binding:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19107
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19108 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19109 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19110 (defun the-the ()
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19111 "Search forward for for a duplicated word."
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19112 (interactive)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19113 (message "Searching for for duplicated words ...")
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19114 (push-mark)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19115 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19116 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19117 ;; This regexp is not perfect
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19118 ;; but is fairly good over all:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19119 (if (re-search-forward
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19120 "\\b\\([^@@ \n\t]+\\)[ \n\t]+\\1\\b" nil 'move)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19121 (message "Found duplicated word.")
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19122 (message "End of buffer")))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19123 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19124
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19125 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19126 ;; Bind `the-the' to C-c \
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19127 (global-set-key "\C-c\\" 'the-the)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19128 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19129 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19130
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19131 @sp 1
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19132 Here is test text:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19133
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19134 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19135 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19136 one two two three four five
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19137 five six seven
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19138 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19139 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19140
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19141 You can substitute the other regular expressions shown above in the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19142 function definition and try each of them on this list.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19143
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19144 @node Kill Ring, Full Graph, the-the, Top
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19145 @appendix Handling the Kill Ring
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19146 @cindex Kill ring handling
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19147 @cindex Handling the kill ring
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19148 @cindex Ring, making a list like a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19149
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19150 The kill ring is a list that is transformed into a ring by the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19151 workings of the @code{current-kill} function. The @code{yank} and
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19152 @code{yank-pop} commands use the @code{current-kill} function.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19153
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19154 This appendix describes the @code{current-kill} function as well as
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19155 both the @code{yank} and the @code{yank-pop} commands, but first,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19156 consider the workings of the kill ring.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19157
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19158 @menu
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19159 * What the Kill Ring Does::
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19160 * current-kill::
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19161 * yank:: Paste a copy of a clipped element.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19162 * yank-pop:: Insert element pointed to.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19163 * ring file::
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19164 @end menu
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19165
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19166 @node What the Kill Ring Does, current-kill, Kill Ring, Kill Ring
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19167 @ifnottex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19168 @unnumberedsec What the Kill Ring Does
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19169 @end ifnottex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19170
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19171 @need 1250
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19172 The kill ring has a default maximum length of sixty items; this number
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19173 is too large for an explanation. Instead, set it to four. Please
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19174 evaluate the following:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19175
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19176 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19177 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19178 (setq old-kill-ring-max kill-ring-max)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19179 (setq kill-ring-max 4)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19180 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19181 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19182
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19183 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19184 Then, please copy each line of the following indented example into the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19185 kill ring. You may kill each line with @kbd{C-k} or mark it and copy
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19186 it with @kbd{M-w}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19187
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19188 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19189 (In a read-only buffer, such as the @file{*info*} buffer, the kill
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19190 command, @kbd{C-k} (@code{kill-line}), will not remove the text,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19191 merely copy it to the kill ring. However, your machine may beep at
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19192 you. Alternatively, for silence, you may copy the region of each line
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19193 with the @kbd{M-w} (@code{kill-ring-save}) command. You must mark
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19194 each line for this command to succeed, but it does not matter at which
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19195 end you put point or mark.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19196
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19197 @need 1250
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19198 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19199 Please invoke the calls in order, so that five elements attempt to
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19200 fill the kill ring:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19201
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19202 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19203 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19204 first some text
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19205 second piece of text
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19206 third line
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19207 fourth line of text
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19208 fifth bit of text
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19209 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19210 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19211
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19212 @need 1250
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19213 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19214 Then find the value of @code{kill-ring} by evaluating
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19215
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19216 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19217 kill-ring
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19218 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19219
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19220 @need 800
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19221 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19222 It is:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19223
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19224 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19225 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19226 ("fifth bit of text" "fourth line of text"
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19227 "third line" "second piece of text")
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19228 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19229 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19230
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19231 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19232 The first element, @samp{first some text}, was dropped.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19233
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19234 @need 1250
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19235 To return to the old value for the length of the kill ring, evaluate:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19236
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19237 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19238 (setq kill-ring-max old-kill-ring-max)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19239 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19240
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19241 @node current-kill, yank, What the Kill Ring Does, Kill Ring
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19242 @comment node-name, next, previous, up
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19243 @appendixsec The @code{current-kill} Function
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19244 @findex current-kill
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19245
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19246 The @code{current-kill} function changes the element in the kill ring
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19247 to which @code{kill-ring-yank-pointer} points. (Also, the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19248 @code{kill-new} function sets @code{kill-ring-yank-pointer} to point
102151
328f4b370b74 Remove duplicate words.
Juanma Barranquero <lekktu@gmail.com>
parents: 100974
diff changeset
19249 to the latest element of the kill ring. The @code{kill-new}
83955
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19250 function is used directly or indirectly by @code{kill-append},
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19251 @code{copy-region-as-kill}, @code{kill-ring-save}, @code{kill-line},
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19252 and @code{kill-region}.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19253
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19254 @menu
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19255 * Code for current-kill::
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19256 * Understanding current-kill::
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19257 @end menu
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19258
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19259 @node Code for current-kill, Understanding current-kill, current-kill, current-kill
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19260 @ifnottex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19261 @unnumberedsubsec The code for @code{current-kill}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19262 @end ifnottex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19263
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19264
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19265 @need 1500
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19266 The @code{current-kill} function is used by @code{yank} and by
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19267 @code{yank-pop}. Here is the code for @code{current-kill}:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19268
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19269 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19270 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19271 (defun current-kill (n &optional do-not-move)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19272 "Rotate the yanking point by N places, and then return that kill.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19273 If N is zero, `interprogram-paste-function' is set, and calling it
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19274 returns a string, then that string is added to the front of the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19275 kill ring and returned as the latest kill.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19276 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19277 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19278 If optional arg DO-NOT-MOVE is non-nil, then don't actually move the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19279 yanking point; just return the Nth kill forward."
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19280 (let ((interprogram-paste (and (= n 0)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19281 interprogram-paste-function
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19282 (funcall interprogram-paste-function))))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19283 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19284 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19285 (if interprogram-paste
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19286 (progn
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19287 ;; Disable the interprogram cut function when we add the new
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19288 ;; text to the kill ring, so Emacs doesn't try to own the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19289 ;; selection, with identical text.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19290 (let ((interprogram-cut-function nil))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19291 (kill-new interprogram-paste))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19292 interprogram-paste)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19293 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19294 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19295 (or kill-ring (error "Kill ring is empty"))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19296 (let ((ARGth-kill-element
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19297 (nthcdr (mod (- n (length kill-ring-yank-pointer))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19298 (length kill-ring))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19299 kill-ring)))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19300 (or do-not-move
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19301 (setq kill-ring-yank-pointer ARGth-kill-element))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19302 (car ARGth-kill-element)))))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19303 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19304 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19305
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19306 Remember also that the @code{kill-new} function sets
102151
328f4b370b74 Remove duplicate words.
Juanma Barranquero <lekktu@gmail.com>
parents: 100974
diff changeset
19307 @code{kill-ring-yank-pointer} to the latest element of the kill
83955
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19308 ring, which means that all the functions that call it set the value
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19309 indirectly: @code{kill-append}, @code{copy-region-as-kill},
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19310 @code{kill-ring-save}, @code{kill-line}, and @code{kill-region}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19311
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19312 @need 1500
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19313 Here is the line in @code{kill-new}, which is explained in
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19314 @ref{kill-new function, , The @code{kill-new} function}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19315
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19316 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19317 (setq kill-ring-yank-pointer kill-ring)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19318 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19319
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19320 @node Understanding current-kill, , Code for current-kill, current-kill
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19321 @ifnottex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19322 @unnumberedsubsec @code{current-kill} in Outline
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19323 @end ifnottex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19324
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19325 The @code{current-kill} function looks complex, but as usual, it can
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19326 be understood by taking it apart piece by piece. First look at it in
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19327 skeletal form:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19328
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19329 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19330 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19331 (defun current-kill (n &optional do-not-move)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19332 "Rotate the yanking point by N places, and then return that kill."
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19333 (let @var{varlist}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19334 @var{body}@dots{})
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19335 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19336 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19337
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19338 This function takes two arguments, one of which is optional. It has a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19339 documentation string. It is @emph{not} interactive.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19340
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19341 @menu
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19342 * Body of current-kill::
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19343 * Digression concerning error:: How to mislead humans, but not computers.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19344 * Determining the Element::
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19345 @end menu
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19346
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19347 @node Body of current-kill, Digression concerning error, Understanding current-kill, Understanding current-kill
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19348 @ifnottex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19349 @unnumberedsubsubsec The Body of @code{current-kill}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19350 @end ifnottex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19351
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19352 The body of the function definition is a @code{let} expression, which
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19353 itself has a body as well as a @var{varlist}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19354
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19355 The @code{let} expression declares a variable that will be only usable
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19356 within the bounds of this function. This variable is called
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19357 @code{interprogram-paste} and is for copying to another program. It
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19358 is not for copying within this instance of GNU Emacs. Most window
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19359 systems provide a facility for interprogram pasting. Sadly, that
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19360 facility usually provides only for the last element. Most windowing
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19361 systems have not adopted a ring of many possibilities, even though
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19362 Emacs has provided it for decades.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19363
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19364 The @code{if} expression has two parts, one if there exists
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19365 @code{interprogram-paste} and one if not.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19366
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19367 @need 2000
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19368 Let us consider the `if not' or else-part of the @code{current-kill}
102151
328f4b370b74 Remove duplicate words.
Juanma Barranquero <lekktu@gmail.com>
parents: 100974
diff changeset
19369 function. (The then-part uses the @code{kill-new} function, which
83955
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19370 we have already described. @xref{kill-new function, , The
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19371 @code{kill-new} function}.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19372
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19373 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19374 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19375 (or kill-ring (error "Kill ring is empty"))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19376 (let ((ARGth-kill-element
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19377 (nthcdr (mod (- n (length kill-ring-yank-pointer))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19378 (length kill-ring))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19379 kill-ring)))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19380 (or do-not-move
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19381 (setq kill-ring-yank-pointer ARGth-kill-element))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19382 (car ARGth-kill-element))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19383 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19384 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19385
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19386 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19387 The code first checks whether the kill ring has content; otherwise it
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19388 signals an error.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19389
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19390 @need 1000
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19391 Note that the @code{or} expression is very similar to testing length
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19392 with an @code{if}:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19393
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19394 @findex zerop
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19395 @findex error
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19396 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19397 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19398 (if (zerop (length kill-ring)) ; @r{if-part}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19399 (error "Kill ring is empty")) ; @r{then-part}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19400 ;; No else-part
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19401 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19402 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19403
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19404 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19405 If there is not anything in the kill ring, its length must be zero and
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19406 an error message sent to the user: @samp{Kill ring is empty}. The
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19407 @code{current-kill} function uses an @code{or} expression which is
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19408 simpler. But an @code{if} expression reminds us what goes on.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19409
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19410 This @code{if} expression uses the function @code{zerop} which returns
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19411 true if the value it is testing is zero. When @code{zerop} tests
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19412 true, the then-part of the @code{if} is evaluated. The then-part is a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19413 list starting with the function @code{error}, which is a function that
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19414 is similar to the @code{message} function
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19415 (@pxref{message, , The @code{message} Function}) in that
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19416 it prints a one-line message in the echo area. However, in addition
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19417 to printing a message, @code{error} also stops evaluation of the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19418 function within which it is embedded. This means that the rest of the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19419 function will not be evaluated if the length of the kill ring is zero.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19420
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19421 Then the @code{current-kill} function selects the element to return.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19422 The selection depends on the number of places that @code{current-kill}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19423 rotates and on where @code{kill-ring-yank-pointer} points.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19424
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19425 Next, either the optional @code{do-not-move} argument is true or the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19426 current value of @code{kill-ring-yank-pointer} is set to point to the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19427 list. Finally, another expression returns the first element of the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19428 list even if the @code{do-not-move} argument is true.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19429
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19430 @node Digression concerning error, Determining the Element, Body of current-kill, Understanding current-kill
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19431 @ifnottex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19432 @unnumberedsubsubsec Digression about the word `error'
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19433 @end ifnottex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19434
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19435 In my opinion, it is slightly misleading, at least to humans, to use
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19436 the term `error' as the name of the @code{error} function. A better
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19437 term would be `cancel'. Strictly speaking, of course, you cannot
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19438 point to, much less rotate a pointer to a list that has no length, so
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19439 from the point of view of the computer, the word `error' is correct.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19440 But a human expects to attempt this sort of thing, if only to find out
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19441 whether the kill ring is full or empty. This is an act of
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19442 exploration.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19443
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19444 From the human point of view, the act of exploration and discovery is
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19445 not necessarily an error, and therefore should not be labelled as one,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19446 even in the bowels of a computer. As it is, the code in Emacs implies
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19447 that a human who is acting virtuously, by exploring his or her
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19448 environment, is making an error. This is bad. Even though the computer
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19449 takes the same steps as it does when there is an `error', a term such as
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19450 `cancel' would have a clearer connotation.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19451
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19452 @node Determining the Element, , Digression concerning error, Understanding current-kill
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19453 @ifnottex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19454 @unnumberedsubsubsec Determining the Element
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19455 @end ifnottex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19456
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19457 Among other actions, the else-part of the @code{if} expression sets
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19458 the value of @code{kill-ring-yank-pointer} to
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19459 @code{ARGth-kill-element} when the kill ring has something in it and
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19460 the value of @code{do-not-move} is @code{nil}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19461
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19462 @need 800
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19463 The code looks like this:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19464
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19465 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19466 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19467 (nthcdr (mod (- n (length kill-ring-yank-pointer))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19468 (length kill-ring))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19469 kill-ring)))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19470 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19471 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19472
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19473 This needs some examination. Unless it is not supposed to move the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19474 pointer, the @code{current-kill} function changes where
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19475 @code{kill-ring-yank-pointer} points.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19476 That is what the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19477 @w{@code{(setq kill-ring-yank-pointer ARGth-kill-element))}}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19478 expression does. Also, clearly, @code{ARGth-kill-element} is being
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19479 set to be equal to some @sc{cdr} of the kill ring, using the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19480 @code{nthcdr} function that is described in an earlier section.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19481 (@xref{copy-region-as-kill}.) How does it do this?
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19482
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19483 As we have seen before (@pxref{nthcdr}), the @code{nthcdr} function
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19484 works by repeatedly taking the @sc{cdr} of a list---it takes the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19485 @sc{cdr} of the @sc{cdr} of the @sc{cdr} @dots{}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19486
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19487 @need 800
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19488 The two following expressions produce the same result:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19489
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19490 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19491 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19492 (setq kill-ring-yank-pointer (cdr kill-ring))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19493
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19494 (setq kill-ring-yank-pointer (nthcdr 1 kill-ring))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19495 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19496 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19497
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19498 However, the @code{nthcdr} expression is more complicated. It uses
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19499 the @code{mod} function to determine which @sc{cdr} to select.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19500
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19501 (You will remember to look at inner functions first; indeed, we will
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19502 have to go inside the @code{mod}.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19503
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19504 The @code{mod} function returns the value of its first argument modulo
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19505 the second; that is to say, it returns the remainder after dividing
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19506 the first argument by the second. The value returned has the same
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19507 sign as the second argument.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19508
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19509 @need 800
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19510 Thus,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19511
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19512 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19513 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19514 (mod 12 4)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19515 @result{} 0 ;; @r{because there is no remainder}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19516 (mod 13 4)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19517 @result{} 1
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19518 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19519 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19520
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19521 @need 1250
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19522 In this case, the first argument is often smaller than the second.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19523 That is fine.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19524
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19525 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19526 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19527 (mod 0 4)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19528 @result{} 0
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19529 (mod 1 4)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19530 @result{} 1
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19531 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19532 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19533
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19534 We can guess what the @code{-} function does. It is like @code{+} but
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19535 subtracts instead of adds; the @code{-} function subtracts its second
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19536 argument from its first. Also, we already know what the @code{length}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19537 function does (@pxref{length}). It returns the length of a list.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19538
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19539 And @code{n} is the name of the required argument to the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19540 @code{current-kill} function.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19541
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19542 @need 1250
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19543 So when the first argument to @code{nthcdr} is zero, the @code{nthcdr}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19544 expression returns the whole list, as you can see by evaluating the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19545 following:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19546
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19547 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19548 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19549 ;; kill-ring-yank-pointer @r{and} kill-ring @r{have a length of four}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19550 ;; @r{and} (mod (- 0 4) 4) @result{} 0
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19551 (nthcdr (mod (- 0 4) 4)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19552 '("fourth line of text"
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19553 "third line"
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19554 "second piece of text"
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19555 "first some text"))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19556 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19557 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19558
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19559 @need 1250
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19560 When the first argument to the @code{current-kill} function is one,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19561 the @code{nthcdr} expression returns the list without its first
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19562 element.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19563
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19564 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19565 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19566 (nthcdr (mod (- 1 4) 4)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19567 '("fourth line of text"
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19568 "third line"
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19569 "second piece of text"
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19570 "first some text"))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19571 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19572 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19573
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19574 @cindex @samp{global variable} defined
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19575 @cindex @samp{variable, global}, defined
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19576 Incidentally, both @code{kill-ring} and @code{kill-ring-yank-pointer}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19577 are @dfn{global variables}. That means that any expression in Emacs
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19578 Lisp can access them. They are not like the local variables set by
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19579 @code{let} or like the symbols in an argument list.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19580 Local variables can only be accessed
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19581 within the @code{let} that defines them or the function that specifies
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19582 them in an argument list (and within expressions called by them).
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19583
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19584 @ignore
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19585 @c texi2dvi fails when the name of the section is within ifnottex ...
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19586 (@xref{Prevent confusion, , @code{let} Prevents Confusion}, and
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19587 @ref{defun, , The @code{defun} Special Form}.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19588 @end ignore
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19589
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19590 @node yank, yank-pop, current-kill, Kill Ring
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19591 @comment node-name, next, previous, up
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19592 @appendixsec @code{yank}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19593 @findex yank
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19594
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19595 After learning about @code{current-kill}, the code for the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19596 @code{yank} function is almost easy.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19597
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19598 The @code{yank} function does not use the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19599 @code{kill-ring-yank-pointer} variable directly. It calls
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19600 @code{insert-for-yank} which calls @code{current-kill} which sets the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19601 @code{kill-ring-yank-pointer} variable.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19602
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19603 @need 1250
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19604 The code looks like this:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19605
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19606 @c in GNU Emacs 22
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19607 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19608 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19609 (defun yank (&optional arg)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19610 "Reinsert (\"paste\") the last stretch of killed text.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19611 More precisely, reinsert the stretch of killed text most recently
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19612 killed OR yanked. Put point at end, and set mark at beginning.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19613 With just \\[universal-argument] as argument, same but put point at
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19614 beginning (and mark at end). With argument N, reinsert the Nth most
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19615 recently killed stretch of killed text.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19616
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19617 When this command inserts killed text into the buffer, it honors
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19618 `yank-excluded-properties' and `yank-handler' as described in the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19619 doc string for `insert-for-yank-1', which see.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19620
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19621 See also the command \\[yank-pop]."
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19622 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19623 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19624 (interactive "*P")
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19625 (setq yank-window-start (window-start))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19626 ;; If we don't get all the way thru, make last-command indicate that
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19627 ;; for the following command.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19628 (setq this-command t)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19629 (push-mark (point))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19630 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19631 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19632 (insert-for-yank (current-kill (cond
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19633 ((listp arg) 0)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19634 ((eq arg '-) -2)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19635 (t (1- arg)))))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19636 (if (consp arg)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19637 ;; This is like exchange-point-and-mark,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19638 ;; but doesn't activate the mark.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19639 ;; It is cleaner to avoid activation, even though the command
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19640 ;; loop would deactivate the mark because we inserted text.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19641 (goto-char (prog1 (mark t)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19642 (set-marker (mark-marker) (point) (current-buffer)))))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19643 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19644 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19645 ;; If we do get all the way thru, make this-command indicate that.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19646 (if (eq this-command t)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19647 (setq this-command 'yank))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19648 nil)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19649 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19650 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19651
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19652 The key expression is @code{insert-for-yank}, which inserts the string
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19653 returned by @code{current-kill}, but removes some text properties from
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19654 it.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19655
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19656 However, before getting to that expression, the function sets the value
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19657 of @code{yank-window-start} to the position returned by the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19658 @code{(window-start)} expression, the position at which the display
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19659 currently starts. The @code{yank} function also sets
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19660 @code{this-command} and pushes the mark.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19661
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19662 After it yanks the appropriate element, if the optional argument is a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19663 @sc{cons} rather than a number or nothing, it puts point at beginning
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19664 of the yanked text and mark at its end.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19665
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19666 (The @code{prog1} function is like @code{progn} but returns the value
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19667 of its first argument rather than the value of its last argument. Its
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19668 first argument is forced to return the buffer's mark as an integer.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19669 You can see the documentation for these functions by placing point
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19670 over them in this buffer and then typing @kbd{C-h f}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19671 (@code{describe-function}) followed by a @kbd{RET}; the default is the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19672 function.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19673
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19674 The last part of the function tells what to do when it succeeds.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19675
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19676 @node yank-pop, ring file, yank, Kill Ring
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19677 @comment node-name, next, previous, up
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19678 @appendixsec @code{yank-pop}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19679 @findex yank-pop
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19680
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19681 After understanding @code{yank} and @code{current-kill}, you know how
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19682 to approach the @code{yank-pop} function. Leaving out the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19683 documentation to save space, it looks like this:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19684
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19685 @c GNU Emacs 22
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19686 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19687 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19688 (defun yank-pop (&optional arg)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19689 "@dots{}"
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19690 (interactive "*p")
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19691 (if (not (eq last-command 'yank))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19692 (error "Previous command was not a yank"))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19693 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19694 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19695 (setq this-command 'yank)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19696 (unless arg (setq arg 1))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19697 (let ((inhibit-read-only t)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19698 (before (< (point) (mark t))))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19699 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19700 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19701 (if before
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19702 (funcall (or yank-undo-function 'delete-region) (point) (mark t))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19703 (funcall (or yank-undo-function 'delete-region) (mark t) (point)))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19704 (setq yank-undo-function nil)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19705 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19706 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19707 (set-marker (mark-marker) (point) (current-buffer))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19708 (insert-for-yank (current-kill arg))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19709 ;; Set the window start back where it was in the yank command,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19710 ;; if possible.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19711 (set-window-start (selected-window) yank-window-start t)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19712 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19713 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19714 (if before
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19715 ;; This is like exchange-point-and-mark,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19716 ;; but doesn't activate the mark.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19717 ;; It is cleaner to avoid activation, even though the command
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19718 ;; loop would deactivate the mark because we inserted text.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19719 (goto-char (prog1 (mark t)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19720 (set-marker (mark-marker)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19721 (point)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19722 (current-buffer))))))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19723 nil)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19724 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19725 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19726
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19727 The function is interactive with a small @samp{p} so the prefix
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19728 argument is processed and passed to the function. The command can
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19729 only be used after a previous yank; otherwise an error message is
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19730 sent. This check uses the variable @code{last-command} which is set
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19731 by @code{yank} and is discussed elsewhere.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19732 (@xref{copy-region-as-kill}.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19733
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19734 The @code{let} clause sets the variable @code{before} to true or false
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19735 depending whether point is before or after mark and then the region
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19736 between point and mark is deleted. This is the region that was just
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19737 inserted by the previous yank and it is this text that will be
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19738 replaced.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19739
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19740 @code{funcall} calls its first argument as a function, passing
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19741 remaining arguments to it. The first argument is whatever the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19742 @code{or} expression returns. The two remaining arguments are the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19743 positions of point and mark set by the preceding @code{yank} command.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19744
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19745 There is more, but that is the hardest part.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19746
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19747 @node ring file, , yank-pop, Kill Ring
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19748 @comment node-name, next, previous, up
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19749 @appendixsec The @file{ring.el} File
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19750 @cindex @file{ring.el} file
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19751
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19752 Interestingly, GNU Emacs posses a file called @file{ring.el} that
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19753 provides many of the features we just discussed. But functions such
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19754 as @code{kill-ring-yank-pointer} do not use this library, possibly
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19755 because they were written earlier.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19756
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19757 @node Full Graph, Free Software and Free Manuals, Kill Ring, Top
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19758 @appendix A Graph with Labelled Axes
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19759
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19760 Printed axes help you understand a graph. They convey scale. In an
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19761 earlier chapter (@pxref{Readying a Graph, , Readying a Graph}), we
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19762 wrote the code to print the body of a graph. Here we write the code
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19763 for printing and labelling vertical and horizontal axes, along with the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19764 body itself.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19765
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19766 @menu
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19767 * Labelled Example::
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19768 * print-graph Varlist:: @code{let} expression in @code{print-graph}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19769 * print-Y-axis:: Print a label for the vertical axis.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19770 * print-X-axis:: Print a horizontal label.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19771 * Print Whole Graph:: The function to print a complete graph.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19772 @end menu
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19773
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19774 @node Labelled Example, print-graph Varlist, Full Graph, Full Graph
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19775 @ifnottex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19776 @unnumberedsec Labelled Example Graph
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19777 @end ifnottex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19778
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19779 Since insertions fill a buffer to the right and below point, the new
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19780 graph printing function should first print the Y or vertical axis,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19781 then the body of the graph, and finally the X or horizontal axis.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19782 This sequence lays out for us the contents of the function:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19783
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19784 @enumerate
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19785 @item
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19786 Set up code.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19787
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19788 @item
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19789 Print Y axis.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19790
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19791 @item
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19792 Print body of graph.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19793
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19794 @item
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19795 Print X axis.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19796 @end enumerate
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19797
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19798 @need 800
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19799 Here is an example of how a finished graph should look:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19800
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19801 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19802 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19803 10 -
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19804 *
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19805 * *
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19806 * **
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19807 * ***
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19808 5 - * *******
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19809 * *** *******
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19810 *************
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19811 ***************
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19812 1 - ****************
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19813 | | | |
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19814 1 5 10 15
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19815 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19816 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19817
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19818 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19819 In this graph, both the vertical and the horizontal axes are labelled
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19820 with numbers. However, in some graphs, the horizontal axis is time
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19821 and would be better labelled with months, like this:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19822
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19823 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19824 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19825 5 - *
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19826 * ** *
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19827 *******
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19828 ********** **
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19829 1 - **************
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19830 | ^ |
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19831 Jan June Jan
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19832 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19833 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19834
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19835 Indeed, with a little thought, we can easily come up with a variety of
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19836 vertical and horizontal labelling schemes. Our task could become
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19837 complicated. But complications breed confusion. Rather than permit
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19838 this, it is better choose a simple labelling scheme for our first
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19839 effort, and to modify or replace it later.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19840
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19841 @need 1200
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19842 These considerations suggest the following outline for the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19843 @code{print-graph} function:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19844
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19845 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19846 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19847 (defun print-graph (numbers-list)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19848 "@var{documentation}@dots{}"
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19849 (let ((height @dots{}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19850 @dots{}))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19851 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19852 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19853 (print-Y-axis height @dots{} )
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19854 (graph-body-print numbers-list)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19855 (print-X-axis @dots{} )))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19856 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19857 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19858
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19859 We can work on each part of the @code{print-graph} function definition
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19860 in turn.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19861
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19862 @node print-graph Varlist, print-Y-axis, Labelled Example, Full Graph
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19863 @comment node-name, next, previous, up
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19864 @appendixsec The @code{print-graph} Varlist
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19865 @cindex @code{print-graph} varlist
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19866
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19867 In writing the @code{print-graph} function, the first task is to write
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19868 the varlist in the @code{let} expression. (We will leave aside for the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19869 moment any thoughts about making the function interactive or about the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19870 contents of its documentation string.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19871
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19872 The varlist should set several values. Clearly, the top of the label
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19873 for the vertical axis must be at least the height of the graph, which
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19874 means that we must obtain this information here. Note that the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19875 @code{print-graph-body} function also requires this information. There
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19876 is no reason to calculate the height of the graph in two different
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19877 places, so we should change @code{print-graph-body} from the way we
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19878 defined it earlier to take advantage of the calculation.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19879
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19880 Similarly, both the function for printing the X axis labels and the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19881 @code{print-graph-body} function need to learn the value of the width of
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19882 each symbol. We can perform the calculation here and change the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19883 definition for @code{print-graph-body} from the way we defined it in the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19884 previous chapter.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19885
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19886 The length of the label for the horizontal axis must be at least as long
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19887 as the graph. However, this information is used only in the function
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19888 that prints the horizontal axis, so it does not need to be calculated here.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19889
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19890 These thoughts lead us directly to the following form for the varlist
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19891 in the @code{let} for @code{print-graph}:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19892
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19893 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19894 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19895 (let ((height (apply 'max numbers-list)) ; @r{First version.}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19896 (symbol-width (length graph-blank)))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19897 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19898 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19899
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19900 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19901 As we shall see, this expression is not quite right.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19902
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19903 @need 2000
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19904 @node print-Y-axis, print-X-axis, print-graph Varlist, Full Graph
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19905 @comment node-name, next, previous, up
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19906 @appendixsec The @code{print-Y-axis} Function
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19907 @cindex Axis, print vertical
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19908 @cindex Y axis printing
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19909 @cindex Vertical axis printing
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19910 @cindex Print vertical axis
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19911
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19912 The job of the @code{print-Y-axis} function is to print a label for
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19913 the vertical axis that looks like this:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19914
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19915 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19916 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19917 10 -
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19918
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19919
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19920
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19921
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19922 5 -
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19923
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19924
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19925
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19926 1 -
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19927 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19928 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19929
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19930 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19931 The function should be passed the height of the graph, and then should
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19932 construct and insert the appropriate numbers and marks.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19933
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19934 @menu
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19935 * print-Y-axis in Detail::
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19936 * Height of label:: What height for the Y axis?
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19937 * Compute a Remainder:: How to compute the remainder of a division.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19938 * Y Axis Element:: Construct a line for the Y axis.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19939 * Y-axis-column:: Generate a list of Y axis labels.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19940 * print-Y-axis Penultimate:: A not quite final version.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19941 @end menu
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19942
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19943 @node print-Y-axis in Detail, Height of label, print-Y-axis, print-Y-axis
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19944 @ifnottex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19945 @unnumberedsubsec The @code{print-Y-axis} Function in Detail
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19946 @end ifnottex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19947
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19948 It is easy enough to see in the figure what the Y axis label should
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19949 look like; but to say in words, and then to write a function
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19950 definition to do the job is another matter. It is not quite true to
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19951 say that we want a number and a tic every five lines: there are only
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19952 three lines between the @samp{1} and the @samp{5} (lines 2, 3, and 4),
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19953 but four lines between the @samp{5} and the @samp{10} (lines 6, 7, 8,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19954 and 9). It is better to say that we want a number and a tic mark on
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19955 the base line (number 1) and then that we want a number and a tic on
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19956 the fifth line from the bottom and on every line that is a multiple of
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19957 five.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19958
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19959 @node Height of label, Compute a Remainder, print-Y-axis in Detail, print-Y-axis
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19960 @ifnottex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19961 @unnumberedsubsec What height should the label be?
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19962 @end ifnottex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19963
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19964 The next issue is what height the label should be? Suppose the maximum
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19965 height of tallest column of the graph is seven. Should the highest
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19966 label on the Y axis be @samp{5 -}, and should the graph stick up above
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19967 the label? Or should the highest label be @samp{7 -}, and mark the peak
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19968 of the graph? Or should the highest label be @code{10 -}, which is a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19969 multiple of five, and be higher than the topmost value of the graph?
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19970
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19971 The latter form is preferred. Most graphs are drawn within rectangles
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19972 whose sides are an integral number of steps long---5, 10, 15, and so
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19973 on for a step distance of five. But as soon as we decide to use a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19974 step height for the vertical axis, we discover that the simple
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19975 expression in the varlist for computing the height is wrong. The
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19976 expression is @code{(apply 'max numbers-list)}. This returns the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19977 precise height, not the maximum height plus whatever is necessary to
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19978 round up to the nearest multiple of five. A more complex expression
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19979 is required.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19980
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19981 As usual in cases like this, a complex problem becomes simpler if it is
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19982 divided into several smaller problems.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19983
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19984 First, consider the case when the highest value of the graph is an
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19985 integral multiple of five---when it is 5, 10, 15, or some higher
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19986 multiple of five. We can use this value as the Y axis height.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19987
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19988 A fairly simply way to determine whether a number is a multiple of
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19989 five is to divide it by five and see if the division results in a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19990 remainder. If there is no remainder, the number is a multiple of
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19991 five. Thus, seven divided by five has a remainder of two, and seven
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19992 is not an integral multiple of five. Put in slightly different
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19993 language, more reminiscent of the classroom, five goes into seven
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19994 once, with a remainder of two. However, five goes into ten twice,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19995 with no remainder: ten is an integral multiple of five.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19996
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19997 @node Compute a Remainder, Y Axis Element, Height of label, print-Y-axis
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19998 @appendixsubsec Side Trip: Compute a Remainder
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19999
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20000 @findex % @r{(remainder function)}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20001 @cindex Remainder function, @code{%}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20002 In Lisp, the function for computing a remainder is @code{%}. The
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20003 function returns the remainder of its first argument divided by its
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20004 second argument. As it happens, @code{%} is a function in Emacs Lisp
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20005 that you cannot discover using @code{apropos}: you find nothing if you
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20006 type @kbd{M-x apropos @key{RET} remainder @key{RET}}. The only way to
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20007 learn of the existence of @code{%} is to read about it in a book such
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20008 as this or in the Emacs Lisp sources.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20009
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20010 You can try the @code{%} function by evaluating the following two
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20011 expressions:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20012
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20013 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20014 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20015 (% 7 5)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20016
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20017 (% 10 5)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20018 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20019 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20020
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20021 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20022 The first expression returns 2 and the second expression returns 0.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20023
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20024 To test whether the returned value is zero or some other number, we
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20025 can use the @code{zerop} function. This function returns @code{t} if
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20026 its argument, which must be a number, is zero.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20027
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20028 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20029 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20030 (zerop (% 7 5))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20031 @result{} nil
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20032
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20033 (zerop (% 10 5))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20034 @result{} t
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20035 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20036 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20037
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20038 Thus, the following expression will return @code{t} if the height
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20039 of the graph is evenly divisible by five:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20040
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20041 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20042 (zerop (% height 5))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20043 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20044
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20045 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20046 (The value of @code{height}, of course, can be found from @code{(apply
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20047 'max numbers-list)}.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20048
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20049 On the other hand, if the value of @code{height} is not a multiple of
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20050 five, we want to reset the value to the next higher multiple of five.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20051 This is straightforward arithmetic using functions with which we are
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20052 already familiar. First, we divide the value of @code{height} by five
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20053 to determine how many times five goes into the number. Thus, five
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20054 goes into twelve twice. If we add one to this quotient and multiply by
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20055 five, we will obtain the value of the next multiple of five that is
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20056 larger than the height. Five goes into twelve twice. Add one to two,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20057 and multiply by five; the result is fifteen, which is the next multiple
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20058 of five that is higher than twelve. The Lisp expression for this is:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20059
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20060 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20061 (* (1+ (/ height 5)) 5)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20062 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20063
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20064 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20065 For example, if you evaluate the following, the result is 15:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20066
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20067 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20068 (* (1+ (/ 12 5)) 5)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20069 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20070
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20071 All through this discussion, we have been using `five' as the value
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20072 for spacing labels on the Y axis; but we may want to use some other
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20073 value. For generality, we should replace `five' with a variable to
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20074 which we can assign a value. The best name I can think of for this
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20075 variable is @code{Y-axis-label-spacing}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20076
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20077 @need 1250
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20078 Using this term, and an @code{if} expression, we produce the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20079 following:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20080
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20081 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20082 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20083 (if (zerop (% height Y-axis-label-spacing))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20084 height
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20085 ;; @r{else}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20086 (* (1+ (/ height Y-axis-label-spacing))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20087 Y-axis-label-spacing))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20088 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20089 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20090
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20091 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20092 This expression returns the value of @code{height} itself if the height
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20093 is an even multiple of the value of the @code{Y-axis-label-spacing} or
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20094 else it computes and returns a value of @code{height} that is equal to
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20095 the next higher multiple of the value of the @code{Y-axis-label-spacing}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20096
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20097 We can now include this expression in the @code{let} expression of the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20098 @code{print-graph} function (after first setting the value of
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20099 @code{Y-axis-label-spacing}):
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20100 @vindex Y-axis-label-spacing
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20101
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20102 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20103 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20104 (defvar Y-axis-label-spacing 5
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20105 "Number of lines from one Y axis label to next.")
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20106 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20107
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20108 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20109 @dots{}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20110 (let* ((height (apply 'max numbers-list))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20111 (height-of-top-line
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20112 (if (zerop (% height Y-axis-label-spacing))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20113 height
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20114 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20115 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20116 ;; @r{else}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20117 (* (1+ (/ height Y-axis-label-spacing))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20118 Y-axis-label-spacing)))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20119 (symbol-width (length graph-blank))))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20120 @dots{}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20121 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20122 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20123
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20124 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20125 (Note use of the @code{let*} function: the initial value of height is
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20126 computed once by the @code{(apply 'max numbers-list)} expression and
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20127 then the resulting value of @code{height} is used to compute its
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20128 final value. @xref{fwd-para let, , The @code{let*} expression}, for
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20129 more about @code{let*}.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20130
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20131 @node Y Axis Element, Y-axis-column, Compute a Remainder, print-Y-axis
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20132 @appendixsubsec Construct a Y Axis Element
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20133
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20134 When we print the vertical axis, we want to insert strings such as
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20135 @w{@samp{5 -}} and @w{@samp{10 - }} every five lines.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20136 Moreover, we want the numbers and dashes to line up, so shorter
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20137 numbers must be padded with leading spaces. If some of the strings
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20138 use two digit numbers, the strings with single digit numbers must
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20139 include a leading blank space before the number.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20140
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20141 @findex number-to-string
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20142 To figure out the length of the number, the @code{length} function is
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20143 used. But the @code{length} function works only with a string, not with
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20144 a number. So the number has to be converted from being a number to
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20145 being a string. This is done with the @code{number-to-string} function.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20146 For example,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20147
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20148 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20149 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20150 (length (number-to-string 35))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20151 @result{} 2
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20152
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20153 (length (number-to-string 100))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20154 @result{} 3
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20155 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20156 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20157
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20158 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20159 (@code{number-to-string} is also called @code{int-to-string}; you will
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20160 see this alternative name in various sources.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20161
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20162 In addition, in each label, each number is followed by a string such
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20163 as @w{@samp{ - }}, which we will call the @code{Y-axis-tic} marker.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20164 This variable is defined with @code{defvar}:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20165
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20166 @vindex Y-axis-tic
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20167 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20168 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20169 (defvar Y-axis-tic " - "
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20170 "String that follows number in a Y axis label.")
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20171 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20172 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20173
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20174 The length of the Y label is the sum of the length of the Y axis tic
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20175 mark and the length of the number of the top of the graph.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20176
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20177 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20178 (length (concat (number-to-string height) Y-axis-tic)))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20179 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20180
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20181 This value will be calculated by the @code{print-graph} function in
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20182 its varlist as @code{full-Y-label-width} and passed on. (Note that we
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20183 did not think to include this in the varlist when we first proposed it.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20184
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20185 To make a complete vertical axis label, a tic mark is concatenated
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20186 with a number; and the two together may be preceded by one or more
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20187 spaces depending on how long the number is. The label consists of
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20188 three parts: the (optional) leading spaces, the number, and the tic
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20189 mark. The function is passed the value of the number for the specific
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20190 row, and the value of the width of the top line, which is calculated
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20191 (just once) by @code{print-graph}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20192
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20193 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20194 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20195 (defun Y-axis-element (number full-Y-label-width)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20196 "Construct a NUMBERed label element.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20197 A numbered element looks like this ` 5 - ',
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20198 and is padded as needed so all line up with
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20199 the element for the largest number."
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20200 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20201 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20202 (let* ((leading-spaces
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20203 (- full-Y-label-width
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20204 (length
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20205 (concat (number-to-string number)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20206 Y-axis-tic)))))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20207 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20208 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20209 (concat
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20210 (make-string leading-spaces ? )
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20211 (number-to-string number)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20212 Y-axis-tic)))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20213 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20214 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20215
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20216 The @code{Y-axis-element} function concatenates together the leading
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20217 spaces, if any; the number, as a string; and the tic mark.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20218
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20219 To figure out how many leading spaces the label will need, the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20220 function subtracts the actual length of the label---the length of the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20221 number plus the length of the tic mark---from the desired label width.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20222
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20223 @findex make-string
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20224 Blank spaces are inserted using the @code{make-string} function. This
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20225 function takes two arguments: the first tells it how long the string
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20226 will be and the second is a symbol for the character to insert, in a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20227 special format. The format is a question mark followed by a blank
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20228 space, like this, @samp{? }. @xref{Character Type, , Character Type,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20229 elisp, The GNU Emacs Lisp Reference Manual}, for a description of the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20230 syntax for characters. (Of course, you might want to replace the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20231 blank space by some other character @dots{} You know what to do.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20232
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20233 The @code{number-to-string} function is used in the concatenation
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20234 expression, to convert the number to a string that is concatenated
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20235 with the leading spaces and the tic mark.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20236
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20237 @node Y-axis-column, print-Y-axis Penultimate, Y Axis Element, print-Y-axis
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20238 @appendixsubsec Create a Y Axis Column
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20239
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20240 The preceding functions provide all the tools needed to construct a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20241 function that generates a list of numbered and blank strings to insert
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20242 as the label for the vertical axis:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20243
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20244 @findex Y-axis-column
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20245 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20246 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20247 (defun Y-axis-column (height width-of-label)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20248 "Construct list of Y axis labels and blank strings.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20249 For HEIGHT of line above base and WIDTH-OF-LABEL."
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20250 (let (Y-axis)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20251 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20252 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20253 (while (> height 1)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20254 (if (zerop (% height Y-axis-label-spacing))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20255 ;; @r{Insert label.}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20256 (setq Y-axis
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20257 (cons
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20258 (Y-axis-element height width-of-label)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20259 Y-axis))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20260 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20261 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20262 ;; @r{Else, insert blanks.}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20263 (setq Y-axis
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20264 (cons
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20265 (make-string width-of-label ? )
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20266 Y-axis)))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20267 (setq height (1- height)))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20268 ;; @r{Insert base line.}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20269 (setq Y-axis
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20270 (cons (Y-axis-element 1 width-of-label) Y-axis))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20271 (nreverse Y-axis)))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20272 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20273 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20274
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20275 In this function, we start with the value of @code{height} and
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20276 repetitively subtract one from its value. After each subtraction, we
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20277 test to see whether the value is an integral multiple of the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20278 @code{Y-axis-label-spacing}. If it is, we construct a numbered label
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20279 using the @code{Y-axis-element} function; if not, we construct a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20280 blank label using the @code{make-string} function. The base line
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20281 consists of the number one followed by a tic mark.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20282
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20283 @need 2000
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20284 @node print-Y-axis Penultimate, , Y-axis-column, print-Y-axis
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20285 @appendixsubsec The Not Quite Final Version of @code{print-Y-axis}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20286
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20287 The list constructed by the @code{Y-axis-column} function is passed to
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20288 the @code{print-Y-axis} function, which inserts the list as a column.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20289
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20290 @findex print-Y-axis
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20291 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20292 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20293 (defun print-Y-axis (height full-Y-label-width)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20294 "Insert Y axis using HEIGHT and FULL-Y-LABEL-WIDTH.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20295 Height must be the maximum height of the graph.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20296 Full width is the width of the highest label element."
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20297 ;; Value of height and full-Y-label-width
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20298 ;; are passed by `print-graph'.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20299 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20300 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20301 (let ((start (point)))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20302 (insert-rectangle
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20303 (Y-axis-column height full-Y-label-width))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20304 ;; @r{Place point ready for inserting graph.}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20305 (goto-char start)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20306 ;; @r{Move point forward by value of} full-Y-label-width
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20307 (forward-char full-Y-label-width)))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20308 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20309 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20310
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20311 The @code{print-Y-axis} uses the @code{insert-rectangle} function to
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20312 insert the Y axis labels created by the @code{Y-axis-column} function.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20313 In addition, it places point at the correct position for printing the body of
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20314 the graph.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20315
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20316 You can test @code{print-Y-axis}:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20317
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20318 @enumerate
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20319 @item
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20320 Install
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20321
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20322 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20323 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20324 Y-axis-label-spacing
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20325 Y-axis-tic
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20326 Y-axis-element
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20327 Y-axis-column
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20328 print-Y-axis
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20329 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20330 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20331
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20332 @item
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20333 Copy the following expression:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20334
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20335 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20336 (print-Y-axis 12 5)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20337 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20338
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20339 @item
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20340 Switch to the @file{*scratch*} buffer and place the cursor where you
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20341 want the axis labels to start.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20342
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20343 @item
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20344 Type @kbd{M-:} (@code{eval-expression}).
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20345
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20346 @item
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20347 Yank the @code{graph-body-print} expression into the minibuffer
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20348 with @kbd{C-y} (@code{yank)}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20349
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20350 @item
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20351 Press @key{RET} to evaluate the expression.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20352 @end enumerate
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20353
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20354 Emacs will print labels vertically, the top one being @w{@samp{10 -@w{
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20355 }}}. (The @code{print-graph} function will pass the value of
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20356 @code{height-of-top-line}, which in this case will end up as 15,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20357 thereby getting rid of what might appear as a bug.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20358
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20359 @need 2000
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20360 @node print-X-axis, Print Whole Graph, print-Y-axis, Full Graph
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20361 @appendixsec The @code{print-X-axis} Function
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20362 @cindex Axis, print horizontal
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20363 @cindex X axis printing
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20364 @cindex Print horizontal axis
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20365 @cindex Horizontal axis printing
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20366
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20367 X axis labels are much like Y axis labels, except that the ticks are on a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20368 line above the numbers. Labels should look like this:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20369
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20370 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20371 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20372 | | | |
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20373 1 5 10 15
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20374 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20375 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20376
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20377 The first tic is under the first column of the graph and is preceded by
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20378 several blank spaces. These spaces provide room in rows above for the Y
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20379 axis labels. The second, third, fourth, and subsequent ticks are all
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20380 spaced equally, according to the value of @code{X-axis-label-spacing}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20381
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20382 The second row of the X axis consists of numbers, preceded by several
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20383 blank spaces and also separated according to the value of the variable
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20384 @code{X-axis-label-spacing}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20385
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20386 The value of the variable @code{X-axis-label-spacing} should itself be
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20387 measured in units of @code{symbol-width}, since you may want to change
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20388 the width of the symbols that you are using to print the body of the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20389 graph without changing the ways the graph is labelled.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20390
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20391 @menu
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20392 * Similarities differences:: Much like @code{print-Y-axis}, but not exactly.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20393 * X Axis Tic Marks:: Create tic marks for the horizontal axis.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20394 @end menu
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20395
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20396 @node Similarities differences, X Axis Tic Marks, print-X-axis, print-X-axis
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20397 @ifnottex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20398 @unnumberedsubsec Similarities and differences
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20399 @end ifnottex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20400
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20401 The @code{print-X-axis} function is constructed in more or less the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20402 same fashion as the @code{print-Y-axis} function except that it has
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20403 two lines: the line of tic marks and the numbers. We will write a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20404 separate function to print each line and then combine them within the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20405 @code{print-X-axis} function.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20406
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20407 This is a three step process:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20408
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20409 @enumerate
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20410 @item
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20411 Write a function to print the X axis tic marks, @code{print-X-axis-tic-line}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20412
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20413 @item
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20414 Write a function to print the X numbers, @code{print-X-axis-numbered-line}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20415
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20416 @item
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20417 Write a function to print both lines, the @code{print-X-axis} function,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20418 using @code{print-X-axis-tic-line} and
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20419 @code{print-X-axis-numbered-line}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20420 @end enumerate
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20421
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20422 @node X Axis Tic Marks, , Similarities differences, print-X-axis
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20423 @appendixsubsec X Axis Tic Marks
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20424
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20425 The first function should print the X axis tic marks. We must specify
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20426 the tic marks themselves and their spacing:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20427
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20428 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20429 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20430 (defvar X-axis-label-spacing
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20431 (if (boundp 'graph-blank)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20432 (* 5 (length graph-blank)) 5)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20433 "Number of units from one X axis label to next.")
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20434 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20435 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20436
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20437 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20438 (Note that the value of @code{graph-blank} is set by another
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20439 @code{defvar}. The @code{boundp} predicate checks whether it has
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20440 already been set; @code{boundp} returns @code{nil} if it has not. If
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20441 @code{graph-blank} were unbound and we did not use this conditional
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20442 construction, in a recent GNU Emacs, we would enter the debugger and
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20443 see an error message saying @samp{@w{Debugger entered--Lisp error:}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20444 @w{(void-variable graph-blank)}}.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20445
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20446 @need 1200
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20447 Here is the @code{defvar} for @code{X-axis-tic-symbol}:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20448
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20449 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20450 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20451 (defvar X-axis-tic-symbol "|"
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20452 "String to insert to point to a column in X axis.")
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20453 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20454 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20455
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20456 @need 1250
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20457 The goal is to make a line that looks like this:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20458
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20459 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20460 | | | |
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20461 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20462
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20463 The first tic is indented so that it is under the first column, which is
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20464 indented to provide space for the Y axis labels.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20465
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20466 A tic element consists of the blank spaces that stretch from one tic to
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20467 the next plus a tic symbol. The number of blanks is determined by the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20468 width of the tic symbol and the @code{X-axis-label-spacing}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20469
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20470 @need 1250
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20471 The code looks like this:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20472
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20473 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20474 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20475 ;;; X-axis-tic-element
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20476 @dots{}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20477 (concat
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20478 (make-string
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20479 ;; @r{Make a string of blanks.}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20480 (- (* symbol-width X-axis-label-spacing)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20481 (length X-axis-tic-symbol))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20482 ? )
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20483 ;; @r{Concatenate blanks with tic symbol.}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20484 X-axis-tic-symbol)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20485 @dots{}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20486 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20487 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20488
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20489 Next, we determine how many blanks are needed to indent the first tic
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20490 mark to the first column of the graph. This uses the value of
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20491 @code{full-Y-label-width} passed it by the @code{print-graph} function.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20492
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20493 @need 1250
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20494 The code to make @code{X-axis-leading-spaces}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20495 looks like this:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20496
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20497 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20498 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20499 ;; X-axis-leading-spaces
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20500 @dots{}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20501 (make-string full-Y-label-width ? )
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20502 @dots{}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20503 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20504 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20505
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20506 We also need to determine the length of the horizontal axis, which is
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20507 the length of the numbers list, and the number of ticks in the horizontal
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20508 axis:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20509
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20510 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20511 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20512 ;; X-length
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20513 @dots{}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20514 (length numbers-list)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20515 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20516
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20517 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20518 ;; tic-width
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20519 @dots{}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20520 (* symbol-width X-axis-label-spacing)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20521 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20522
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20523 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20524 ;; number-of-X-ticks
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20525 (if (zerop (% (X-length tic-width)))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20526 (/ (X-length tic-width))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20527 (1+ (/ (X-length tic-width))))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20528 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20529 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20530
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20531 @need 1250
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20532 All this leads us directly to the function for printing the X axis tic line:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20533
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20534 @findex print-X-axis-tic-line
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20535 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20536 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20537 (defun print-X-axis-tic-line
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20538 (number-of-X-tics X-axis-leading-spaces X-axis-tic-element)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20539 "Print ticks for X axis."
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20540 (insert X-axis-leading-spaces)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20541 (insert X-axis-tic-symbol) ; @r{Under first column.}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20542 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20543 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20544 ;; @r{Insert second tic in the right spot.}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20545 (insert (concat
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20546 (make-string
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20547 (- (* symbol-width X-axis-label-spacing)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20548 ;; @r{Insert white space up to second tic symbol.}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20549 (* 2 (length X-axis-tic-symbol)))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20550 ? )
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20551 X-axis-tic-symbol))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20552 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20553 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20554 ;; @r{Insert remaining ticks.}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20555 (while (> number-of-X-tics 1)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20556 (insert X-axis-tic-element)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20557 (setq number-of-X-tics (1- number-of-X-tics))))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20558 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20559 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20560
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20561 The line of numbers is equally straightforward:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20562
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20563 @need 1250
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20564 First, we create a numbered element with blank spaces before each number:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20565
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20566 @findex X-axis-element
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20567 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20568 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20569 (defun X-axis-element (number)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20570 "Construct a numbered X axis element."
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20571 (let ((leading-spaces
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20572 (- (* symbol-width X-axis-label-spacing)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20573 (length (number-to-string number)))))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20574 (concat (make-string leading-spaces ? )
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20575 (number-to-string number))))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20576 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20577 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20578
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20579 Next, we create the function to print the numbered line, starting with
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20580 the number ``1'' under the first column:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20581
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20582 @findex print-X-axis-numbered-line
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20583 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20584 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20585 (defun print-X-axis-numbered-line
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20586 (number-of-X-tics X-axis-leading-spaces)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20587 "Print line of X-axis numbers"
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20588 (let ((number X-axis-label-spacing))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20589 (insert X-axis-leading-spaces)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20590 (insert "1")
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20591 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20592 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20593 (insert (concat
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20594 (make-string
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20595 ;; @r{Insert white space up to next number.}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20596 (- (* symbol-width X-axis-label-spacing) 2)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20597 ? )
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20598 (number-to-string number)))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20599 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20600 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20601 ;; @r{Insert remaining numbers.}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20602 (setq number (+ number X-axis-label-spacing))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20603 (while (> number-of-X-tics 1)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20604 (insert (X-axis-element number))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20605 (setq number (+ number X-axis-label-spacing))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20606 (setq number-of-X-tics (1- number-of-X-tics)))))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20607 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20608 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20609
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20610 Finally, we need to write the @code{print-X-axis} that uses
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20611 @code{print-X-axis-tic-line} and
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20612 @code{print-X-axis-numbered-line}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20613
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20614 The function must determine the local values of the variables used by both
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20615 @code{print-X-axis-tic-line} and @code{print-X-axis-numbered-line}, and
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20616 then it must call them. Also, it must print the carriage return that
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20617 separates the two lines.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20618
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20619 The function consists of a varlist that specifies five local variables,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20620 and calls to each of the two line printing functions:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20621
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20622 @findex print-X-axis
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20623 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20624 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20625 (defun print-X-axis (numbers-list)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20626 "Print X axis labels to length of NUMBERS-LIST."
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20627 (let* ((leading-spaces
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20628 (make-string full-Y-label-width ? ))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20629 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20630 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20631 ;; symbol-width @r{is provided by} graph-body-print
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20632 (tic-width (* symbol-width X-axis-label-spacing))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20633 (X-length (length numbers-list))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20634 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20635 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20636 (X-tic
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20637 (concat
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20638 (make-string
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20639 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20640 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20641 ;; @r{Make a string of blanks.}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20642 (- (* symbol-width X-axis-label-spacing)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20643 (length X-axis-tic-symbol))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20644 ? )
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20645 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20646 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20647 ;; @r{Concatenate blanks with tic symbol.}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20648 X-axis-tic-symbol))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20649 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20650 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20651 (tic-number
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20652 (if (zerop (% X-length tic-width))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20653 (/ X-length tic-width)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20654 (1+ (/ X-length tic-width)))))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20655 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20656 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20657 (print-X-axis-tic-line tic-number leading-spaces X-tic)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20658 (insert "\n")
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20659 (print-X-axis-numbered-line tic-number leading-spaces)))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20660 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20661 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20662
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20663 @need 1250
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20664 You can test @code{print-X-axis}:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20665
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20666 @enumerate
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20667 @item
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20668 Install @code{X-axis-tic-symbol}, @code{X-axis-label-spacing},
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20669 @code{print-X-axis-tic-line}, as well as @code{X-axis-element},
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20670 @code{print-X-axis-numbered-line}, and @code{print-X-axis}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20671
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20672 @item
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20673 Copy the following expression:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20674
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20675 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20676 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20677 (progn
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20678 (let ((full-Y-label-width 5)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20679 (symbol-width 1))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20680 (print-X-axis
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20681 '(1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16))))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20682 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20683 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20684
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20685 @item
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20686 Switch to the @file{*scratch*} buffer and place the cursor where you
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20687 want the axis labels to start.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20688
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20689 @item
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20690 Type @kbd{M-:} (@code{eval-expression}).
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20691
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20692 @item
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20693 Yank the test expression into the minibuffer
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20694 with @kbd{C-y} (@code{yank)}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20695
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20696 @item
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20697 Press @key{RET} to evaluate the expression.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20698 @end enumerate
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20699
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20700 @need 1250
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20701 Emacs will print the horizontal axis like this:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20702 @sp 1
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20703
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20704 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20705 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20706 | | | | |
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20707 1 5 10 15 20
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20708 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20709 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20710
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20711 @node Print Whole Graph, , print-X-axis, Full Graph
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20712 @appendixsec Printing the Whole Graph
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20713 @cindex Printing the whole graph
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20714 @cindex Whole graph printing
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20715 @cindex Graph, printing all
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20716
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20717 Now we are nearly ready to print the whole graph.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20718
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20719 The function to print the graph with the proper labels follows the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20720 outline we created earlier (@pxref{Full Graph, , A Graph with Labelled
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20721 Axes}), but with additions.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20722
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20723 @need 1250
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20724 Here is the outline:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20725
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20726 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20727 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20728 (defun print-graph (numbers-list)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20729 "@var{documentation}@dots{}"
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20730 (let ((height @dots{}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20731 @dots{}))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20732 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20733 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20734 (print-Y-axis height @dots{} )
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20735 (graph-body-print numbers-list)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20736 (print-X-axis @dots{} )))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20737 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20738 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20739
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20740 @menu
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20741 * The final version:: A few changes.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20742 * Test print-graph:: Run a short test.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20743 * Graphing words in defuns:: Executing the final code.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20744 * lambda:: How to write an anonymous function.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20745 * mapcar:: Apply a function to elements of a list.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20746 * Another Bug:: Yet another bug @dots{} most insidious.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20747 * Final printed graph:: The graph itself!
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20748 @end menu
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20749
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20750 @node The final version, Test print-graph, Print Whole Graph, Print Whole Graph
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20751 @ifnottex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20752 @unnumberedsubsec Changes for the Final Version
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20753 @end ifnottex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20754
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20755 The final version is different from what we planned in two ways:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20756 first, it contains additional values calculated once in the varlist;
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20757 second, it carries an option to specify the labels' increment per row.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20758 This latter feature turns out to be essential; otherwise, a graph may
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20759 have more rows than fit on a display or on a sheet of paper.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20760
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20761 @need 1500
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20762 This new feature requires a change to the @code{Y-axis-column}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20763 function, to add @code{vertical-step} to it. The function looks like
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20764 this:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20765
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20766 @findex Y-axis-column @r{Final version.}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20767 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20768 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20769 ;;; @r{Final version.}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20770 (defun Y-axis-column
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20771 (height width-of-label &optional vertical-step)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20772 "Construct list of labels for Y axis.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20773 HEIGHT is maximum height of graph.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20774 WIDTH-OF-LABEL is maximum width of label.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20775 VERTICAL-STEP, an option, is a positive integer
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20776 that specifies how much a Y axis label increments
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20777 for each line. For example, a step of 5 means
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20778 that each line is five units of the graph."
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20779 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20780 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20781 (let (Y-axis
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20782 (number-per-line (or vertical-step 1)))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20783 (while (> height 1)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20784 (if (zerop (% height Y-axis-label-spacing))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20785 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20786 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20787 ;; @r{Insert label.}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20788 (setq Y-axis
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20789 (cons
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20790 (Y-axis-element
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20791 (* height number-per-line)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20792 width-of-label)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20793 Y-axis))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20794 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20795 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20796 ;; @r{Else, insert blanks.}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20797 (setq Y-axis
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20798 (cons
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20799 (make-string width-of-label ? )
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20800 Y-axis)))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20801 (setq height (1- height)))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20802 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20803 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20804 ;; @r{Insert base line.}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20805 (setq Y-axis (cons (Y-axis-element
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20806 (or vertical-step 1)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20807 width-of-label)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20808 Y-axis))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20809 (nreverse Y-axis)))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20810 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20811 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20812
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20813 The values for the maximum height of graph and the width of a symbol
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20814 are computed by @code{print-graph} in its @code{let} expression; so
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20815 @code{graph-body-print} must be changed to accept them.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20816
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20817 @findex graph-body-print @r{Final version.}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20818 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20819 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20820 ;;; @r{Final version.}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20821 (defun graph-body-print (numbers-list height symbol-width)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20822 "Print a bar graph of the NUMBERS-LIST.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20823 The numbers-list consists of the Y-axis values.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20824 HEIGHT is maximum height of graph.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20825 SYMBOL-WIDTH is number of each column."
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20826 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20827 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20828 (let (from-position)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20829 (while numbers-list
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20830 (setq from-position (point))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20831 (insert-rectangle
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20832 (column-of-graph height (car numbers-list)))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20833 (goto-char from-position)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20834 (forward-char symbol-width)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20835 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20836 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20837 ;; @r{Draw graph column by column.}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20838 (sit-for 0)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20839 (setq numbers-list (cdr numbers-list)))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20840 ;; @r{Place point for X axis labels.}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20841 (forward-line height)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20842 (insert "\n")))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20843 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20844 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20845
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20846 @need 1250
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20847 Finally, the code for the @code{print-graph} function:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20848
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20849 @findex print-graph @r{Final version.}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20850 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20851 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20852 ;;; @r{Final version.}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20853 (defun print-graph
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20854 (numbers-list &optional vertical-step)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20855 "Print labelled bar graph of the NUMBERS-LIST.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20856 The numbers-list consists of the Y-axis values.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20857 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20858
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20859 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20860 Optionally, VERTICAL-STEP, a positive integer,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20861 specifies how much a Y axis label increments for
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20862 each line. For example, a step of 5 means that
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20863 each row is five units."
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20864 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20865 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20866 (let* ((symbol-width (length graph-blank))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20867 ;; @code{height} @r{is both the largest number}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20868 ;; @r{and the number with the most digits.}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20869 (height (apply 'max numbers-list))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20870 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20871 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20872 (height-of-top-line
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20873 (if (zerop (% height Y-axis-label-spacing))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20874 height
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20875 ;; @r{else}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20876 (* (1+ (/ height Y-axis-label-spacing))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20877 Y-axis-label-spacing)))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20878 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20879 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20880 (vertical-step (or vertical-step 1))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20881 (full-Y-label-width
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20882 (length
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20883 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20884 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20885 (concat
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20886 (number-to-string
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20887 (* height-of-top-line vertical-step))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20888 Y-axis-tic))))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20889 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20890
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20891 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20892 (print-Y-axis
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20893 height-of-top-line full-Y-label-width vertical-step)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20894 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20895 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20896 (graph-body-print
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20897 numbers-list height-of-top-line symbol-width)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20898 (print-X-axis numbers-list)))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20899 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20900 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20901
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20902 @node Test print-graph, Graphing words in defuns, The final version, Print Whole Graph
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20903 @appendixsubsec Testing @code{print-graph}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20904
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20905 @need 1250
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20906 We can test the @code{print-graph} function with a short list of numbers:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20907
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20908 @enumerate
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20909 @item
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20910 Install the final versions of @code{Y-axis-column},
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20911 @code{graph-body-print}, and @code{print-graph} (in addition to the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20912 rest of the code.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20913
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20914 @item
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20915 Copy the following expression:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20916
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20917 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20918 (print-graph '(3 2 5 6 7 5 3 4 6 4 3 2 1))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20919 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20920
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20921 @item
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20922 Switch to the @file{*scratch*} buffer and place the cursor where you
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20923 want the axis labels to start.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20924
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20925 @item
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20926 Type @kbd{M-:} (@code{eval-expression}).
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20927
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20928 @item
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20929 Yank the test expression into the minibuffer
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20930 with @kbd{C-y} (@code{yank)}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20931
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20932 @item
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20933 Press @key{RET} to evaluate the expression.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20934 @end enumerate
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20935
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20936 @need 1250
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20937 Emacs will print a graph that looks like this:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20938
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20939 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20940 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20941 10 -
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20942
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20943
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20944 *
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20945 ** *
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20946 5 - **** *
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20947 **** ***
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20948 * *********
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20949 ************
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20950 1 - *************
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20951
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20952 | | | |
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20953 1 5 10 15
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20954 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20955 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20956
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20957 @need 1200
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20958 On the other hand, if you pass @code{print-graph} a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20959 @code{vertical-step} value of 2, by evaluating this expression:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20960
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20961 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20962 (print-graph '(3 2 5 6 7 5 3 4 6 4 3 2 1) 2)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20963 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20964
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20965 @need 1250
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20966 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20967 The graph looks like this:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20968
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20969 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20970 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20971 20 -
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20972
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20973
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20974 *
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20975 ** *
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20976 10 - **** *
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20977 **** ***
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20978 * *********
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20979 ************
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20980 2 - *************
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20981
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20982 | | | |
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20983 1 5 10 15
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20984 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20985 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20986
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20987 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20988 (A question: is the `2' on the bottom of the vertical axis a bug or a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20989 feature? If you think it is a bug, and should be a `1' instead, (or
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20990 even a `0'), you can modify the sources.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20991
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20992 @node Graphing words in defuns, lambda, Test print-graph, Print Whole Graph
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20993 @appendixsubsec Graphing Numbers of Words and Symbols
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20994
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20995 Now for the graph for which all this code was written: a graph that
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20996 shows how many function definitions contain fewer than 10 words and
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20997 symbols, how many contain between 10 and 19 words and symbols, how
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20998 many contain between 20 and 29 words and symbols, and so on.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20999
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21000 This is a multi-step process. First make sure you have loaded all the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21001 requisite code.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21002
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21003 @need 1500
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21004 It is a good idea to reset the value of @code{top-of-ranges} in case
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21005 you have set it to some different value. You can evaluate the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21006 following:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21007
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21008 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21009 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21010 (setq top-of-ranges
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21011 '(10 20 30 40 50
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21012 60 70 80 90 100
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21013 110 120 130 140 150
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21014 160 170 180 190 200
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21015 210 220 230 240 250
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21016 260 270 280 290 300)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21017 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21018 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21019
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21020 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21021 Next create a list of the number of words and symbols in each range.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21022
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21023 @need 1500
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21024 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21025 Evaluate the following:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21026
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21027 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21028 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21029 (setq list-for-graph
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21030 (defuns-per-range
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21031 (sort
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21032 (recursive-lengths-list-many-files
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21033 (directory-files "/usr/local/emacs/lisp"
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21034 t ".+el$"))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21035 '<)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21036 top-of-ranges))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21037 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21038 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21039
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21040 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21041 On my old machine, this took about an hour. It looked though 303 Lisp
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21042 files in my copy of Emacs version 19.23. After all that computing,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21043 the @code{list-for-graph} had this value:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21044
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21045 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21046 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21047 (537 1027 955 785 594 483 349 292 224 199 166 120 116 99
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21048 90 80 67 48 52 45 41 33 28 26 25 20 12 28 11 13 220)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21049 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21050 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21051
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21052 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21053 This means that my copy of Emacs had 537 function definitions with
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21054 fewer than 10 words or symbols in them, 1,027 function definitions
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21055 with 10 to 19 words or symbols in them, 955 function definitions with
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21056 20 to 29 words or symbols in them, and so on.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21057
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21058 Clearly, just by looking at this list we can see that most function
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21059 definitions contain ten to thirty words and symbols.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21060
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21061 Now for printing. We do @emph{not} want to print a graph that is
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21062 1,030 lines high @dots{} Instead, we should print a graph that is
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21063 fewer than twenty-five lines high. A graph that height can be
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21064 displayed on almost any monitor, and easily printed on a sheet of paper.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21065
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21066 This means that each value in @code{list-for-graph} must be reduced to
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21067 one-fiftieth its present value.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21068
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21069 Here is a short function to do just that, using two functions we have
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21070 not yet seen, @code{mapcar} and @code{lambda}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21071
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21072 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21073 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21074 (defun one-fiftieth (full-range)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21075 "Return list, each number one-fiftieth of previous."
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21076 (mapcar '(lambda (arg) (/ arg 50)) full-range))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21077 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21078 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21079
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21080 @node lambda, mapcar, Graphing words in defuns, Print Whole Graph
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21081 @appendixsubsec A @code{lambda} Expression: Useful Anonymity
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21082 @cindex Anonymous function
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21083 @findex lambda
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21084
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21085 @code{lambda} is the symbol for an anonymous function, a function
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21086 without a name. Every time you use an anonymous function, you need to
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21087 include its whole body.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21088
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21089 @need 1250
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21090 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21091 Thus,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21092
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21093 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21094 (lambda (arg) (/ arg 50))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21095 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21096
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21097 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21098 is a function definition that says `return the value resulting from
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21099 dividing whatever is passed to me as @code{arg} by 50'.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21100
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21101 @need 1200
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21102 Earlier, for example, we had a function @code{multiply-by-seven}; it
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21103 multiplied its argument by 7. This function is similar, except it
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21104 divides its argument by 50; and, it has no name. The anonymous
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21105 equivalent of @code{multiply-by-seven} is:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21106
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21107 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21108 (lambda (number) (* 7 number))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21109 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21110
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21111 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21112 (@xref{defun, , The @code{defun} Special Form}.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21113
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21114 @need 1250
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21115 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21116 If we want to multiply 3 by 7, we can write:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21117
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21118 @c !!! Clear print-postscript-figures if the computer formatting this
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21119 @c document is too small and cannot handle all the diagrams and figures.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21120 @c clear print-postscript-figures
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21121 @c set print-postscript-figures
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21122 @c lambda example diagram #1
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21123 @ifnottex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21124 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21125 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21126 (multiply-by-seven 3)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21127 \_______________/ ^
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21128 | |
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21129 function argument
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21130 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21131 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21132 @end ifnottex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21133 @ifset print-postscript-figures
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21134 @sp 1
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21135 @tex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21136 @center @image{lambda-1}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21137 %%%% old method of including an image
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21138 % \input /usr/local/lib/tex/inputs/psfig.tex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21139 % \centerline{\psfig{figure=/usr/local/lib/emacs/man/lambda-1.eps}}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21140 % \catcode`\@=0 %
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21141 @end tex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21142 @sp 1
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21143 @end ifset
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21144 @ifclear print-postscript-figures
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21145 @iftex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21146 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21147 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21148 (multiply-by-seven 3)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21149 \_______________/ ^
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21150 | |
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21151 function argument
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21152 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21153 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21154 @end iftex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21155 @end ifclear
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21156
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21157 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21158 This expression returns 21.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21159
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21160 @need 1250
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21161 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21162 Similarly, we can write:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21163
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21164 @c lambda example diagram #2
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21165 @ifnottex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21166 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21167 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21168 ((lambda (number) (* 7 number)) 3)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21169 \____________________________/ ^
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21170 | |
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21171 anonymous function argument
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21172 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21173 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21174 @end ifnottex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21175 @ifset print-postscript-figures
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21176 @sp 1
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21177 @tex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21178 @center @image{lambda-2}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21179 %%%% old method of including an image
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21180 % \input /usr/local/lib/tex/inputs/psfig.tex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21181 % \centerline{\psfig{figure=/usr/local/lib/emacs/man/lambda-2.eps}}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21182 % \catcode`\@=0 %
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21183 @end tex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21184 @sp 1
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21185 @end ifset
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21186 @ifclear print-postscript-figures
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21187 @iftex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21188 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21189 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21190 ((lambda (number) (* 7 number)) 3)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21191 \____________________________/ ^
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21192 | |
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21193 anonymous function argument
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21194 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21195 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21196 @end iftex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21197 @end ifclear
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21198
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21199 @need 1250
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21200 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21201 If we want to divide 100 by 50, we can write:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21202
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21203 @c lambda example diagram #3
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21204 @ifnottex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21205 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21206 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21207 ((lambda (arg) (/ arg 50)) 100)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21208 \______________________/ \_/
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21209 | |
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21210 anonymous function argument
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21211 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21212 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21213 @end ifnottex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21214 @ifset print-postscript-figures
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21215 @sp 1
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21216 @tex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21217 @center @image{lambda-3}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21218 %%%% old method of including an image
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21219 % \input /usr/local/lib/tex/inputs/psfig.tex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21220 % \centerline{\psfig{figure=/usr/local/lib/emacs/man/lambda-3.eps}}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21221 % \catcode`\@=0 %
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21222 @end tex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21223 @sp 1
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21224 @end ifset
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21225 @ifclear print-postscript-figures
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21226 @iftex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21227 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21228 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21229 ((lambda (arg) (/ arg 50)) 100)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21230 \______________________/ \_/
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21231 | |
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21232 anonymous function argument
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21233 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21234 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21235 @end iftex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21236 @end ifclear
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21237
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21238 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21239 This expression returns 2. The 100 is passed to the function, which
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21240 divides that number by 50.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21241
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21242 @xref{Lambda Expressions, , Lambda Expressions, elisp, The GNU Emacs
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21243 Lisp Reference Manual}, for more about @code{lambda}. Lisp and lambda
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21244 expressions derive from the Lambda Calculus.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21245
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21246 @node mapcar, Another Bug, lambda, Print Whole Graph
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21247 @appendixsubsec The @code{mapcar} Function
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21248 @findex mapcar
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21249
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21250 @code{mapcar} is a function that calls its first argument with each
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21251 element of its second argument, in turn. The second argument must be
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21252 a sequence.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21253
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21254 The @samp{map} part of the name comes from the mathematical phrase,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21255 `mapping over a domain', meaning to apply a function to each of the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21256 elements in a domain. The mathematical phrase is based on the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21257 metaphor of a surveyor walking, one step at a time, over an area he is
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21258 mapping. And @samp{car}, of course, comes from the Lisp notion of the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21259 first of a list.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21260
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21261 @need 1250
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21262 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21263 For example,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21264
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21265 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21266 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21267 (mapcar '1+ '(2 4 6))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21268 @result{} (3 5 7)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21269 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21270 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21271
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21272 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21273 The function @code{1+} which adds one to its argument, is executed on
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21274 @emph{each} element of the list, and a new list is returned.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21275
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21276 Contrast this with @code{apply}, which applies its first argument to
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21277 all the remaining.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21278 (@xref{Readying a Graph, , Readying a Graph}, for a explanation of
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21279 @code{apply}.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21280
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21281 @need 1250
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21282 In the definition of @code{one-fiftieth}, the first argument is the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21283 anonymous function:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21284
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21285 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21286 (lambda (arg) (/ arg 50))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21287 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21288
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21289 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21290 and the second argument is @code{full-range}, which will be bound to
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21291 @code{list-for-graph}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21292
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21293 @need 1250
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21294 The whole expression looks like this:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21295
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21296 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21297 (mapcar '(lambda (arg) (/ arg 50)) full-range))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21298 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21299
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21300 @xref{Mapping Functions, , Mapping Functions, elisp, The GNU Emacs
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21301 Lisp Reference Manual}, for more about @code{mapcar}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21302
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21303 Using the @code{one-fiftieth} function, we can generate a list in
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21304 which each element is one-fiftieth the size of the corresponding
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21305 element in @code{list-for-graph}.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21306
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21307 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21308 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21309 (setq fiftieth-list-for-graph
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21310 (one-fiftieth list-for-graph))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21311 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21312 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21313
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21314 @need 1250
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21315 The resulting list looks like this:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21316
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21317 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21318 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21319 (10 20 19 15 11 9 6 5 4 3 3 2 2
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21320 1 1 1 1 0 1 0 0 0 0 0 0 0 0 0 0 0 4)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21321 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21322 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21323
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21324 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21325 This, we are almost ready to print! (We also notice the loss of
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21326 information: many of the higher ranges are 0, meaning that fewer than
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21327 50 defuns had that many words or symbols---but not necessarily meaning
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21328 that none had that many words or symbols.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21329
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21330 @node Another Bug, Final printed graph, mapcar, Print Whole Graph
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21331 @appendixsubsec Another Bug @dots{} Most Insidious
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21332 @cindex Bug, most insidious type
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21333 @cindex Insidious type of bug
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21334
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21335 I said `almost ready to print'! Of course, there is a bug in the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21336 @code{print-graph} function @dots{} It has a @code{vertical-step}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21337 option, but not a @code{horizontal-step} option. The
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21338 @code{top-of-range} scale goes from 10 to 300 by tens. But the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21339 @code{print-graph} function will print only by ones.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21340
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21341 This is a classic example of what some consider the most insidious
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21342 type of bug, the bug of omission. This is not the kind of bug you can
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21343 find by studying the code, for it is not in the code; it is an omitted
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21344 feature. Your best actions are to try your program early and often;
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21345 and try to arrange, as much as you can, to write code that is easy to
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21346 understand and easy to change. Try to be aware, whenever you can,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21347 that whatever you have written, @emph{will} be rewritten, if not soon,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21348 eventually. A hard maxim to follow.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21349
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21350 It is the @code{print-X-axis-numbered-line} function that needs the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21351 work; and then the @code{print-X-axis} and the @code{print-graph}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21352 functions need to be adapted. Not much needs to be done; there is one
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21353 nicety: the numbers ought to line up under the tic marks. This takes
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21354 a little thought.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21355
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21356 @need 1250
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21357 Here is the corrected @code{print-X-axis-numbered-line}:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21358
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21359 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21360 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21361 (defun print-X-axis-numbered-line
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21362 (number-of-X-tics X-axis-leading-spaces
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21363 &optional horizontal-step)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21364 "Print line of X-axis numbers"
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21365 (let ((number X-axis-label-spacing)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21366 (horizontal-step (or horizontal-step 1)))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21367 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21368 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21369 (insert X-axis-leading-spaces)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21370 ;; @r{Delete extra leading spaces.}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21371 (delete-char
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21372 (- (1-
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21373 (length (number-to-string horizontal-step)))))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21374 (insert (concat
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21375 (make-string
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21376 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21377 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21378 ;; @r{Insert white space.}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21379 (- (* symbol-width
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21380 X-axis-label-spacing)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21381 (1-
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21382 (length
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21383 (number-to-string horizontal-step)))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21384 2)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21385 ? )
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21386 (number-to-string
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21387 (* number horizontal-step))))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21388 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21389 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21390 ;; @r{Insert remaining numbers.}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21391 (setq number (+ number X-axis-label-spacing))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21392 (while (> number-of-X-tics 1)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21393 (insert (X-axis-element
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21394 (* number horizontal-step)))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21395 (setq number (+ number X-axis-label-spacing))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21396 (setq number-of-X-tics (1- number-of-X-tics)))))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21397 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21398 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21399
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21400 @need 1500
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21401 If you are reading this in Info, you can see the new versions of
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21402 @code{print-X-axis} @code{print-graph} and evaluate them. If you are
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21403 reading this in a printed book, you can see the changed lines here
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21404 (the full text is too much to print).
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21405
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21406 @iftex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21407 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21408 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21409 (defun print-X-axis (numbers-list horizontal-step)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21410 @dots{}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21411 (print-X-axis-numbered-line
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21412 tic-number leading-spaces horizontal-step))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21413 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21414 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21415
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21416 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21417 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21418 (defun print-graph
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21419 (numbers-list
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21420 &optional vertical-step horizontal-step)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21421 @dots{}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21422 (print-X-axis numbers-list horizontal-step))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21423 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21424 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21425 @end iftex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21426
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21427 @ifnottex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21428 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21429 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21430 (defun print-X-axis (numbers-list horizontal-step)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21431 "Print X axis labels to length of NUMBERS-LIST.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21432 Optionally, HORIZONTAL-STEP, a positive integer,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21433 specifies how much an X axis label increments for
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21434 each column."
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21435 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21436 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21437 ;; Value of symbol-width and full-Y-label-width
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21438 ;; are passed by `print-graph'.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21439 (let* ((leading-spaces
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21440 (make-string full-Y-label-width ? ))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21441 ;; symbol-width @r{is provided by} graph-body-print
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21442 (tic-width (* symbol-width X-axis-label-spacing))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21443 (X-length (length numbers-list))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21444 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21445 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21446 (X-tic
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21447 (concat
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21448 (make-string
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21449 ;; @r{Make a string of blanks.}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21450 (- (* symbol-width X-axis-label-spacing)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21451 (length X-axis-tic-symbol))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21452 ? )
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21453 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21454 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21455 ;; @r{Concatenate blanks with tic symbol.}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21456 X-axis-tic-symbol))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21457 (tic-number
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21458 (if (zerop (% X-length tic-width))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21459 (/ X-length tic-width)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21460 (1+ (/ X-length tic-width)))))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21461 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21462
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21463 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21464 (print-X-axis-tic-line
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21465 tic-number leading-spaces X-tic)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21466 (insert "\n")
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21467 (print-X-axis-numbered-line
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21468 tic-number leading-spaces horizontal-step)))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21469 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21470 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21471
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21472 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21473 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21474 (defun print-graph
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21475 (numbers-list &optional vertical-step horizontal-step)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21476 "Print labelled bar graph of the NUMBERS-LIST.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21477 The numbers-list consists of the Y-axis values.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21478 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21479
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21480 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21481 Optionally, VERTICAL-STEP, a positive integer,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21482 specifies how much a Y axis label increments for
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21483 each line. For example, a step of 5 means that
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21484 each row is five units.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21485 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21486
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21487 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21488 Optionally, HORIZONTAL-STEP, a positive integer,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21489 specifies how much an X axis label increments for
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21490 each column."
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21491 (let* ((symbol-width (length graph-blank))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21492 ;; @code{height} @r{is both the largest number}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21493 ;; @r{and the number with the most digits.}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21494 (height (apply 'max numbers-list))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21495 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21496 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21497 (height-of-top-line
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21498 (if (zerop (% height Y-axis-label-spacing))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21499 height
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21500 ;; @r{else}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21501 (* (1+ (/ height Y-axis-label-spacing))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21502 Y-axis-label-spacing)))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21503 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21504 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21505 (vertical-step (or vertical-step 1))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21506 (full-Y-label-width
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21507 (length
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21508 (concat
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21509 (number-to-string
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21510 (* height-of-top-line vertical-step))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21511 Y-axis-tic))))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21512 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21513 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21514 (print-Y-axis
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21515 height-of-top-line full-Y-label-width vertical-step)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21516 (graph-body-print
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21517 numbers-list height-of-top-line symbol-width)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21518 (print-X-axis numbers-list horizontal-step)))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21519 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21520 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21521 @end ifnottex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21522
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21523 @c qqq
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21524 @ignore
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21525 Graphing Definitions Re-listed
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21526
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21527 @need 1250
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21528 Here are all the graphing definitions in their final form:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21529
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21530 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21531 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21532 (defvar top-of-ranges
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21533 '(10 20 30 40 50
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21534 60 70 80 90 100
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21535 110 120 130 140 150
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21536 160 170 180 190 200
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21537 210 220 230 240 250)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21538 "List specifying ranges for `defuns-per-range'.")
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21539 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21540
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21541 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21542 (defvar graph-symbol "*"
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21543 "String used as symbol in graph, usually an asterisk.")
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21544 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21545
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21546 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21547 (defvar graph-blank " "
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21548 "String used as blank in graph, usually a blank space.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21549 graph-blank must be the same number of columns wide
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21550 as graph-symbol.")
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21551 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21552
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21553 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21554 (defvar Y-axis-tic " - "
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21555 "String that follows number in a Y axis label.")
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21556 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21557
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21558 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21559 (defvar Y-axis-label-spacing 5
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21560 "Number of lines from one Y axis label to next.")
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21561 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21562
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21563 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21564 (defvar X-axis-tic-symbol "|"
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21565 "String to insert to point to a column in X axis.")
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21566 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21567
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21568 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21569 (defvar X-axis-label-spacing
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21570 (if (boundp 'graph-blank)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21571 (* 5 (length graph-blank)) 5)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21572 "Number of units from one X axis label to next.")
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21573 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21574 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21575
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21576 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21577 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21578 (defun count-words-in-defun ()
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21579 "Return the number of words and symbols in a defun."
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21580 (beginning-of-defun)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21581 (let ((count 0)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21582 (end (save-excursion (end-of-defun) (point))))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21583 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21584
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21585 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21586 (while
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21587 (and (< (point) end)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21588 (re-search-forward
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21589 "\\(\\w\\|\\s_\\)+[^ \t\n]*[ \t\n]*"
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21590 end t))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21591 (setq count (1+ count)))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21592 count))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21593 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21594 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21595
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21596 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21597 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21598 (defun lengths-list-file (filename)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21599 "Return list of definitions' lengths within FILE.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21600 The returned list is a list of numbers.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21601 Each number is the number of words or
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21602 symbols in one function definition."
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21603 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21604
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21605 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21606 (message "Working on `%s' ... " filename)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21607 (save-excursion
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21608 (let ((buffer (find-file-noselect filename))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21609 (lengths-list))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21610 (set-buffer buffer)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21611 (setq buffer-read-only t)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21612 (widen)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21613 (goto-char (point-min))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21614 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21615
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21616 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21617 (while (re-search-forward "^(defun" nil t)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21618 (setq lengths-list
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21619 (cons (count-words-in-defun) lengths-list)))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21620 (kill-buffer buffer)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21621 lengths-list)))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21622 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21623 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21624
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21625 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21626 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21627 (defun lengths-list-many-files (list-of-files)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21628 "Return list of lengths of defuns in LIST-OF-FILES."
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21629 (let (lengths-list)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21630 ;;; @r{true-or-false-test}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21631 (while list-of-files
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21632 (setq lengths-list
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21633 (append
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21634 lengths-list
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21635 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21636 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21637 ;;; @r{Generate a lengths' list.}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21638 (lengths-list-file
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21639 (expand-file-name (car list-of-files)))))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21640 ;;; @r{Make files' list shorter.}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21641 (setq list-of-files (cdr list-of-files)))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21642 ;;; @r{Return final value of lengths' list.}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21643 lengths-list))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21644 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21645 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21646
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21647 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21648 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21649 (defun defuns-per-range (sorted-lengths top-of-ranges)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21650 "SORTED-LENGTHS defuns in each TOP-OF-RANGES range."
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21651 (let ((top-of-range (car top-of-ranges))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21652 (number-within-range 0)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21653 defuns-per-range-list)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21654 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21655
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21656 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21657 ;; @r{Outer loop.}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21658 (while top-of-ranges
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21659
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21660 ;; @r{Inner loop.}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21661 (while (and
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21662 ;; @r{Need number for numeric test.}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21663 (car sorted-lengths)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21664 (< (car sorted-lengths) top-of-range))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21665
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21666 ;; @r{Count number of definitions within current range.}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21667 (setq number-within-range (1+ number-within-range))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21668 (setq sorted-lengths (cdr sorted-lengths)))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21669 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21670
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21671 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21672 ;; @r{Exit inner loop but remain within outer loop.}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21673
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21674 (setq defuns-per-range-list
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21675 (cons number-within-range defuns-per-range-list))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21676 (setq number-within-range 0) ; @r{Reset count to zero.}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21677
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21678 ;; @r{Move to next range.}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21679 (setq top-of-ranges (cdr top-of-ranges))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21680 ;; @r{Specify next top of range value.}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21681 (setq top-of-range (car top-of-ranges)))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21682 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21683
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21684 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21685 ;; @r{Exit outer loop and count the number of defuns larger than}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21686 ;; @r{ the largest top-of-range value.}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21687 (setq defuns-per-range-list
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21688 (cons
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21689 (length sorted-lengths)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21690 defuns-per-range-list))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21691
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21692 ;; @r{Return a list of the number of definitions within each range,}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21693 ;; @r{ smallest to largest.}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21694 (nreverse defuns-per-range-list)))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21695 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21696 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21697
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21698 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21699 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21700 (defun column-of-graph (max-graph-height actual-height)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21701 "Return list of MAX-GRAPH-HEIGHT strings;
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21702 ACTUAL-HEIGHT are graph-symbols.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21703 The graph-symbols are contiguous entries at the end
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21704 of the list.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21705 The list will be inserted as one column of a graph.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21706 The strings are either graph-blank or graph-symbol."
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21707 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21708
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21709 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21710 (let ((insert-list nil)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21711 (number-of-top-blanks
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21712 (- max-graph-height actual-height)))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21713
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21714 ;; @r{Fill in @code{graph-symbols}.}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21715 (while (> actual-height 0)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21716 (setq insert-list (cons graph-symbol insert-list))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21717 (setq actual-height (1- actual-height)))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21718 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21719
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21720 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21721 ;; @r{Fill in @code{graph-blanks}.}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21722 (while (> number-of-top-blanks 0)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21723 (setq insert-list (cons graph-blank insert-list))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21724 (setq number-of-top-blanks
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21725 (1- number-of-top-blanks)))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21726
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21727 ;; @r{Return whole list.}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21728 insert-list))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21729 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21730 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21731
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21732 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21733 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21734 (defun Y-axis-element (number full-Y-label-width)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21735 "Construct a NUMBERed label element.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21736 A numbered element looks like this ` 5 - ',
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21737 and is padded as needed so all line up with
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21738 the element for the largest number."
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21739 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21740 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21741 (let* ((leading-spaces
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21742 (- full-Y-label-width
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21743 (length
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21744 (concat (number-to-string number)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21745 Y-axis-tic)))))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21746 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21747 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21748 (concat
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21749 (make-string leading-spaces ? )
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21750 (number-to-string number)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21751 Y-axis-tic)))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21752 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21753 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21754
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21755 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21756 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21757 (defun print-Y-axis
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21758 (height full-Y-label-width &optional vertical-step)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21759 "Insert Y axis by HEIGHT and FULL-Y-LABEL-WIDTH.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21760 Height must be the maximum height of the graph.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21761 Full width is the width of the highest label element.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21762 Optionally, print according to VERTICAL-STEP."
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21763 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21764 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21765 ;; Value of height and full-Y-label-width
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21766 ;; are passed by `print-graph'.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21767 (let ((start (point)))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21768 (insert-rectangle
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21769 (Y-axis-column height full-Y-label-width vertical-step))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21770 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21771 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21772 ;; @r{Place point ready for inserting graph.}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21773 (goto-char start)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21774 ;; @r{Move point forward by value of} full-Y-label-width
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21775 (forward-char full-Y-label-width)))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21776 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21777 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21778
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21779 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21780 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21781 (defun print-X-axis-tic-line
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21782 (number-of-X-tics X-axis-leading-spaces X-axis-tic-element)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21783 "Print ticks for X axis."
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21784 (insert X-axis-leading-spaces)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21785 (insert X-axis-tic-symbol) ; @r{Under first column.}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21786 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21787 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21788 ;; @r{Insert second tic in the right spot.}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21789 (insert (concat
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21790 (make-string
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21791 (- (* symbol-width X-axis-label-spacing)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21792 ;; @r{Insert white space up to second tic symbol.}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21793 (* 2 (length X-axis-tic-symbol)))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21794 ? )
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21795 X-axis-tic-symbol))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21796 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21797 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21798 ;; @r{Insert remaining ticks.}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21799 (while (> number-of-X-tics 1)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21800 (insert X-axis-tic-element)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21801 (setq number-of-X-tics (1- number-of-X-tics))))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21802 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21803 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21804
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21805 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21806 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21807 (defun X-axis-element (number)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21808 "Construct a numbered X axis element."
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21809 (let ((leading-spaces
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21810 (- (* symbol-width X-axis-label-spacing)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21811 (length (number-to-string number)))))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21812 (concat (make-string leading-spaces ? )
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21813 (number-to-string number))))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21814 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21815 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21816
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21817 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21818 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21819 (defun graph-body-print (numbers-list height symbol-width)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21820 "Print a bar graph of the NUMBERS-LIST.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21821 The numbers-list consists of the Y-axis values.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21822 HEIGHT is maximum height of graph.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21823 SYMBOL-WIDTH is number of each column."
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21824 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21825 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21826 (let (from-position)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21827 (while numbers-list
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21828 (setq from-position (point))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21829 (insert-rectangle
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21830 (column-of-graph height (car numbers-list)))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21831 (goto-char from-position)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21832 (forward-char symbol-width)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21833 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21834 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21835 ;; @r{Draw graph column by column.}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21836 (sit-for 0)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21837 (setq numbers-list (cdr numbers-list)))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21838 ;; @r{Place point for X axis labels.}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21839 (forward-line height)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21840 (insert "\n")))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21841 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21842 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21843
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21844 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21845 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21846 (defun Y-axis-column
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21847 (height width-of-label &optional vertical-step)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21848 "Construct list of labels for Y axis.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21849 HEIGHT is maximum height of graph.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21850 WIDTH-OF-LABEL is maximum width of label.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21851 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21852 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21853 VERTICAL-STEP, an option, is a positive integer
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21854 that specifies how much a Y axis label increments
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21855 for each line. For example, a step of 5 means
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21856 that each line is five units of the graph."
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21857 (let (Y-axis
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21858 (number-per-line (or vertical-step 1)))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21859 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21860 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21861 (while (> height 1)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21862 (if (zerop (% height Y-axis-label-spacing))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21863 ;; @r{Insert label.}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21864 (setq Y-axis
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21865 (cons
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21866 (Y-axis-element
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21867 (* height number-per-line)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21868 width-of-label)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21869 Y-axis))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21870 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21871 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21872 ;; @r{Else, insert blanks.}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21873 (setq Y-axis
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21874 (cons
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21875 (make-string width-of-label ? )
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21876 Y-axis)))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21877 (setq height (1- height)))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21878 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21879 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21880 ;; @r{Insert base line.}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21881 (setq Y-axis (cons (Y-axis-element
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21882 (or vertical-step 1)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21883 width-of-label)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21884 Y-axis))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21885 (nreverse Y-axis)))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21886 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21887 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21888
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21889 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21890 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21891 (defun print-X-axis-numbered-line
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21892 (number-of-X-tics X-axis-leading-spaces
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21893 &optional horizontal-step)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21894 "Print line of X-axis numbers"
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21895 (let ((number X-axis-label-spacing)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21896 (horizontal-step (or horizontal-step 1)))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21897 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21898 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21899 (insert X-axis-leading-spaces)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21900 ;; line up number
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21901 (delete-char (- (1- (length (number-to-string horizontal-step)))))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21902 (insert (concat
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21903 (make-string
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21904 ;; @r{Insert white space up to next number.}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21905 (- (* symbol-width X-axis-label-spacing)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21906 (1- (length (number-to-string horizontal-step)))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21907 2)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21908 ? )
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21909 (number-to-string (* number horizontal-step))))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21910 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21911 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21912 ;; @r{Insert remaining numbers.}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21913 (setq number (+ number X-axis-label-spacing))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21914 (while (> number-of-X-tics 1)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21915 (insert (X-axis-element (* number horizontal-step)))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21916 (setq number (+ number X-axis-label-spacing))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21917 (setq number-of-X-tics (1- number-of-X-tics)))))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21918 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21919 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21920
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21921 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21922 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21923 (defun print-X-axis (numbers-list horizontal-step)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21924 "Print X axis labels to length of NUMBERS-LIST.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21925 Optionally, HORIZONTAL-STEP, a positive integer,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21926 specifies how much an X axis label increments for
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21927 each column."
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21928 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21929 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21930 ;; Value of symbol-width and full-Y-label-width
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21931 ;; are passed by `print-graph'.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21932 (let* ((leading-spaces
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21933 (make-string full-Y-label-width ? ))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21934 ;; symbol-width @r{is provided by} graph-body-print
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21935 (tic-width (* symbol-width X-axis-label-spacing))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21936 (X-length (length numbers-list))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21937 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21938 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21939 (X-tic
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21940 (concat
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21941 (make-string
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21942 ;; @r{Make a string of blanks.}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21943 (- (* symbol-width X-axis-label-spacing)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21944 (length X-axis-tic-symbol))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21945 ? )
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21946 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21947 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21948 ;; @r{Concatenate blanks with tic symbol.}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21949 X-axis-tic-symbol))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21950 (tic-number
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21951 (if (zerop (% X-length tic-width))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21952 (/ X-length tic-width)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21953 (1+ (/ X-length tic-width)))))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21954 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21955
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21956 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21957 (print-X-axis-tic-line
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21958 tic-number leading-spaces X-tic)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21959 (insert "\n")
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21960 (print-X-axis-numbered-line
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21961 tic-number leading-spaces horizontal-step)))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21962 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21963 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21964
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21965 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21966 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21967 (defun one-fiftieth (full-range)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21968 "Return list, each number of which is 1/50th previous."
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21969 (mapcar '(lambda (arg) (/ arg 50)) full-range))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21970 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21971 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21972
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21973 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21974 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21975 (defun print-graph
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21976 (numbers-list &optional vertical-step horizontal-step)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21977 "Print labelled bar graph of the NUMBERS-LIST.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21978 The numbers-list consists of the Y-axis values.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21979 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21980
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21981 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21982 Optionally, VERTICAL-STEP, a positive integer,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21983 specifies how much a Y axis label increments for
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21984 each line. For example, a step of 5 means that
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21985 each row is five units.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21986 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21987
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21988 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21989 Optionally, HORIZONTAL-STEP, a positive integer,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21990 specifies how much an X axis label increments for
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21991 each column."
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21992 (let* ((symbol-width (length graph-blank))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21993 ;; @code{height} @r{is both the largest number}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21994 ;; @r{and the number with the most digits.}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21995 (height (apply 'max numbers-list))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21996 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21997 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21998 (height-of-top-line
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21999 (if (zerop (% height Y-axis-label-spacing))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22000 height
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22001 ;; @r{else}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22002 (* (1+ (/ height Y-axis-label-spacing))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22003 Y-axis-label-spacing)))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22004 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22005 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22006 (vertical-step (or vertical-step 1))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22007 (full-Y-label-width
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22008 (length
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22009 (concat
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22010 (number-to-string
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22011 (* height-of-top-line vertical-step))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22012 Y-axis-tic))))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22013 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22014 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22015
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22016 (print-Y-axis
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22017 height-of-top-line full-Y-label-width vertical-step)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22018 (graph-body-print
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22019 numbers-list height-of-top-line symbol-width)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22020 (print-X-axis numbers-list horizontal-step)))
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22021 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22022 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22023 @c qqq
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22024 @end ignore
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22025
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22026 @page
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22027 @node Final printed graph, , Another Bug, Print Whole Graph
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22028 @appendixsubsec The Printed Graph
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22029
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22030 When made and installed, you can call the @code{print-graph} command
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22031 like this:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22032 @sp 1
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22033
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22034 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22035 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22036 (print-graph fiftieth-list-for-graph 50 10)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22037 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22038 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22039 @sp 1
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22040
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22041 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22042 Here is the graph:
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22043 @sp 2
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22044
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22045 @smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22046 @group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22047 1000 - *
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22048 **
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22049 **
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22050 **
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22051 **
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22052 750 - ***
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22053 ***
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22054 ***
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22055 ***
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22056 ****
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22057 500 - *****
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22058 ******
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22059 ******
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22060 ******
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22061 *******
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22062 250 - ********
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22063 ********* *
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22064 *********** *
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22065 ************* *
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22066 50 - ***************** * *
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22067 | | | | | | | |
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22068 10 50 100 150 200 250 300 350
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22069 @end group
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22070 @end smallexample
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22071
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22072 @sp 2
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22073
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22074 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22075 The largest group of functions contain 10 -- 19 words and symbols each.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22076
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22077 @node Free Software and Free Manuals, GNU Free Documentation License, Full Graph, Top
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22078 @appendix Free Software and Free Manuals
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22079
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22080 @strong{by Richard M. Stallman}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22081 @sp 1
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22082
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22083 The biggest deficiency in free operating systems is not in the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22084 software---it is the lack of good free manuals that we can include in
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22085 these systems. Many of our most important programs do not come with
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22086 full manuals. Documentation is an essential part of any software
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22087 package; when an important free software package does not come with a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22088 free manual, that is a major gap. We have many such gaps today.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22089
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22090 Once upon a time, many years ago, I thought I would learn Perl. I got
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22091 a copy of a free manual, but I found it hard to read. When I asked
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22092 Perl users about alternatives, they told me that there were better
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22093 introductory manuals---but those were not free.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22094
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22095 Why was this? The authors of the good manuals had written them for
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22096 O'Reilly Associates, which published them with restrictive terms---no
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22097 copying, no modification, source files not available---which exclude
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22098 them from the free software community.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22099
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22100 That wasn't the first time this sort of thing has happened, and (to
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22101 our community's great loss) it was far from the last. Proprietary
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22102 manual publishers have enticed a great many authors to restrict their
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22103 manuals since then. Many times I have heard a GNU user eagerly tell me
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22104 about a manual that he is writing, with which he expects to help the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22105 GNU project---and then had my hopes dashed, as he proceeded to explain
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22106 that he had signed a contract with a publisher that would restrict it
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22107 so that we cannot use it.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22108
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22109 Given that writing good English is a rare skill among programmers, we
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22110 can ill afford to lose manuals this way.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22111
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22112 Free documentation, like free software, is a matter of freedom, not
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22113 price. The problem with these manuals was not that O'Reilly Associates
106382
2ae01aa75e84 (Free Software and Free Manuals): Update URL, and remove duplicate text.
Glenn Morris <rgm@gnu.org>
parents: 105790
diff changeset
22114 charged a price for printed copies---that in itself is fine. The Free
2ae01aa75e84 (Free Software and Free Manuals): Update URL, and remove duplicate text.
Glenn Morris <rgm@gnu.org>
parents: 105790
diff changeset
22115 Software Foundation @uref{http://shop.fsf.org, sells printed copies} of
2ae01aa75e84 (Free Software and Free Manuals): Update URL, and remove duplicate text.
Glenn Morris <rgm@gnu.org>
parents: 105790
diff changeset
22116 free @uref{http://www.gnu.org/doc/doc.html, GNU manuals}, too.
83955
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22117 But GNU manuals are available in source code form, while these manuals
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22118 are available only on paper. GNU manuals come with permission to copy
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22119 and modify; the Perl manuals do not. These restrictions are the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22120 problems.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22121
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22122 The criterion for a free manual is pretty much the same as for free
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22123 software: it is a matter of giving all users certain
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22124 freedoms. Redistribution (including commercial redistribution) must be
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22125 permitted, so that the manual can accompany every copy of the program,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22126 on-line or on paper. Permission for modification is crucial too.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22127
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22128 As a general rule, I don't believe that it is essential for people to
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22129 have permission to modify all sorts of articles and books. The issues
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22130 for writings are not necessarily the same as those for software. For
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22131 example, I don't think you or I are obliged to give permission to
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22132 modify articles like this one, which describe our actions and our
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22133 views.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22134
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22135 But there is a particular reason why the freedom to modify is crucial
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22136 for documentation for free software. When people exercise their right
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22137 to modify the software, and add or change its features, if they are
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22138 conscientious they will change the manual too---so they can provide
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22139 accurate and usable documentation with the modified program. A manual
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22140 which forbids programmers to be conscientious and finish the job, or
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22141 more precisely requires them to write a new manual from scratch if
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22142 they change the program, does not fill our community's needs.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22143
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22144 While a blanket prohibition on modification is unacceptable, some
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22145 kinds of limits on the method of modification pose no problem. For
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22146 example, requirements to preserve the original author's copyright
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22147 notice, the distribution terms, or the list of authors, are ok. It is
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22148 also no problem to require modified versions to include notice that
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22149 they were modified, even to have entire sections that may not be
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22150 deleted or changed, as long as these sections deal with nontechnical
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22151 topics. (Some GNU manuals have them.)
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22152
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22153 These kinds of restrictions are not a problem because, as a practical
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22154 matter, they don't stop the conscientious programmer from adapting the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22155 manual to fit the modified program. In other words, they don't block
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22156 the free software community from making full use of the manual.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22157
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22158 However, it must be possible to modify all the technical content of
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22159 the manual, and then distribute the result in all the usual media,
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22160 through all the usual channels; otherwise, the restrictions do block
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22161 the community, the manual is not free, and so we need another manual.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22162
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22163 Unfortunately, it is often hard to find someone to write another
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22164 manual when a proprietary manual exists. The obstacle is that many
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22165 users think that a proprietary manual is good enough---so they don't
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22166 see the need to write a free manual. They do not see that the free
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22167 operating system has a gap that needs filling.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22168
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22169 Why do users think that proprietary manuals are good enough? Some have
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22170 not considered the issue. I hope this article will do something to
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22171 change that.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22172
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22173 Other users consider proprietary manuals acceptable for the same
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22174 reason so many people consider proprietary software acceptable: they
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22175 judge in purely practical terms, not using freedom as a
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22176 criterion. These people are entitled to their opinions, but since
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22177 those opinions spring from values which do not include freedom, they
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22178 are no guide for those of us who do value freedom.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22179
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22180 Please spread the word about this issue. We continue to lose manuals
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22181 to proprietary publishing. If we spread the word that proprietary
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22182 manuals are not sufficient, perhaps the next person who wants to help
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22183 GNU by writing documentation will realize, before it is too late, that
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22184 he must above all make it free.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22185
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22186 We can also encourage commercial publishers to sell free, copylefted
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22187 manuals instead of proprietary ones. One way you can help this is to
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22188 check the distribution terms of a manual before you buy it, and prefer
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22189 copylefted manuals to non-copylefted ones.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22190
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22191 @sp 2
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22192 @noindent
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22193 Note: The Free Software Foundation maintains a page on its Web site
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22194 that lists free books available from other publishers:@*
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22195 @uref{http://www.gnu.org/doc/other-free-books.html}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22196
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22197 @node GNU Free Documentation License, Index, Free Software and Free Manuals, Top
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22198 @appendix GNU Free Documentation License
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22199
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22200 @cindex FDL, GNU Free Documentation License
99703
fe597ddfd2ca Relicense under FDL 1.3 or later.
Glenn Morris <rgm@gnu.org>
parents: 98770
diff changeset
22201 @include doclicense.texi
83955
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22202
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22203 @node Index, About the Author, GNU Free Documentation License, Top
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22204 @comment node-name, next, previous, up
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22205 @unnumbered Index
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22206
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22207 @ignore
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22208 MENU ENTRY: NODE NAME.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22209 @end ignore
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22210
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22211 @printindex cp
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22212
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22213 @iftex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22214 @c Place biographical information on right-hand (verso) page
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22215
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22216 @tex
98525
b6395ec3de45 formatting fixes for new printed edition
Karl Berry <karl@gnu.org>
parents: 94896
diff changeset
22217 \par\vfill\supereject
83955
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22218 \ifodd\pageno
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22219 \global\evenheadline={\hfil} \global\evenfootline={\hfil}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22220 \global\oddheadline={\hfil} \global\oddfootline={\hfil}
98525
b6395ec3de45 formatting fixes for new printed edition
Karl Berry <karl@gnu.org>
parents: 94896
diff changeset
22221 %\page\hbox{}\page
83955
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22222 \else
98525
b6395ec3de45 formatting fixes for new printed edition
Karl Berry <karl@gnu.org>
parents: 94896
diff changeset
22223 % \par\vfill\supereject
83955
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22224 \global\evenheadline={\hfil} \global\evenfootline={\hfil}
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22225 \global\oddheadline={\hfil} \global\oddfootline={\hfil}
98525
b6395ec3de45 formatting fixes for new printed edition
Karl Berry <karl@gnu.org>
parents: 94896
diff changeset
22226 %\page\hbox{}%\page
b6395ec3de45 formatting fixes for new printed edition
Karl Berry <karl@gnu.org>
parents: 94896
diff changeset
22227 %\page\hbox{}%\page
83955
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22228 \fi
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22229 @end tex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22230
98525
b6395ec3de45 formatting fixes for new printed edition
Karl Berry <karl@gnu.org>
parents: 94896
diff changeset
22231 @c page
83955
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22232 @w{ }
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22233
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22234 @c ================ Biographical information ================
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22235
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22236 @w{ }
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22237 @sp 8
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22238 @center About the Author
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22239 @sp 1
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22240 @end iftex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22241
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22242 @ifnottex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22243 @node About the Author, , Index, Top
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22244 @unnumbered About the Author
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22245 @end ifnottex
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22246
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22247 @quotation
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22248 Robert J. Chassell has worked with GNU Emacs since 1985. He writes
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22249 and edits, teaches Emacs and Emacs Lisp, and speaks throughout the
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22250 world on software freedom. Chassell was a founding Director and
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22251 Treasurer of the Free Software Foundation, Inc. He is co-author of
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22252 the @cite{Texinfo} manual, and has edited more than a dozen other
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22253 books. He graduated from Cambridge University, in England. He has an
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22254 abiding interest in social and economic history and flies his own
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22255 airplane.
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22256 @end quotation
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22257
98525
b6395ec3de45 formatting fixes for new printed edition
Karl Berry <karl@gnu.org>
parents: 94896
diff changeset
22258 @c @page
b6395ec3de45 formatting fixes for new printed edition
Karl Berry <karl@gnu.org>
parents: 94896
diff changeset
22259 @c @w{ }
b6395ec3de45 formatting fixes for new printed edition
Karl Berry <karl@gnu.org>
parents: 94896
diff changeset
22260 @c
b6395ec3de45 formatting fixes for new printed edition
Karl Berry <karl@gnu.org>
parents: 94896
diff changeset
22261 @c @c Prevent page number on blank verso, so eject it first.
b6395ec3de45 formatting fixes for new printed edition
Karl Berry <karl@gnu.org>
parents: 94896
diff changeset
22262 @c @tex
b6395ec3de45 formatting fixes for new printed edition
Karl Berry <karl@gnu.org>
parents: 94896
diff changeset
22263 @c \par\vfill\supereject
b6395ec3de45 formatting fixes for new printed edition
Karl Berry <karl@gnu.org>
parents: 94896
diff changeset
22264 @c @end tex
b6395ec3de45 formatting fixes for new printed edition
Karl Berry <karl@gnu.org>
parents: 94896
diff changeset
22265
b6395ec3de45 formatting fixes for new printed edition
Karl Berry <karl@gnu.org>
parents: 94896
diff changeset
22266 @c @iftex
b6395ec3de45 formatting fixes for new printed edition
Karl Berry <karl@gnu.org>
parents: 94896
diff changeset
22267 @c @headings off
b6395ec3de45 formatting fixes for new printed edition
Karl Berry <karl@gnu.org>
parents: 94896
diff changeset
22268 @c @evenheading @thispage @| @| @thistitle
b6395ec3de45 formatting fixes for new printed edition
Karl Berry <karl@gnu.org>
parents: 94896
diff changeset
22269 @c @oddheading @| @| @thispage
b6395ec3de45 formatting fixes for new printed edition
Karl Berry <karl@gnu.org>
parents: 94896
diff changeset
22270 @c @end iftex
83955
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22271
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22272 @bye
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22273
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22274 @ignore
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22275 arch-tag: da1a2154-531f-43a8-8e33-fc7faad10acf
14bd8cfd94a6 Move here from ../../lispintro/
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22276 @end ignore