Mercurial > emacs
annotate lispref/compile.texi @ 63876:f66c007ebe28
(help-do-arg-highlight): Highlight also -ARG (for example, -NLINES on the
`occur' docstring).
author | Juanma Barranquero <lekktu@gmail.com> |
---|---|
date | Thu, 30 Jun 2005 14:19:11 +0000 |
parents | 99e9892a51d9 |
children | e836425ee789 b7da78284d4c |
rev | line source |
---|---|
5945 | 1 @c -*-texinfo-*- |
2 @c This is part of the GNU Emacs Lisp Reference Manual. | |
49600
23a1cea22d13
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
38160
diff
changeset
|
3 @c Copyright (C) 1990, 1991, 1992, 1993, 1994 Free Software Foundation, Inc. |
5945 | 4 @c See the file elisp.texi for copying conditions. |
5 @setfilename ../info/compile | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
6 @node Byte Compilation, Advising Functions, Loading, Top |
5945 | 7 @chapter Byte Compilation |
8 @cindex byte-code | |
9 @cindex compilation | |
10 | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
11 Emacs Lisp has a @dfn{compiler} that translates functions written |
5945 | 12 in Lisp into a special representation called @dfn{byte-code} that can be |
13 executed more efficiently. The compiler replaces Lisp function | |
14 definitions with byte-code. When a byte-code function is called, its | |
15 definition is evaluated by the @dfn{byte-code interpreter}. | |
16 | |
17 Because the byte-compiled code is evaluated by the byte-code | |
18 interpreter, instead of being executed directly by the machine's | |
19 hardware (as true compiled code is), byte-code is completely | |
20 transportable from machine to machine without recompilation. It is not, | |
21 however, as fast as true compiled code. | |
22 | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
23 Compiling a Lisp file with the Emacs byte compiler always reads the |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
24 file as multibyte text, even if Emacs was started with @samp{--unibyte}, |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
25 unless the file specifies otherwise. This is so that compilation gives |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
26 results compatible with running the same file without compilation. |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
27 @xref{Loading Non-ASCII}. |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
28 |
5945 | 29 In general, any version of Emacs can run byte-compiled code produced |
60036
fafa7c0e2b82
(Byte Compilation): Delete 19.29 info.
Richard M. Stallman <rms@gnu.org>
parents:
55733
diff
changeset
|
30 by recent earlier versions of Emacs, but the reverse is not true. |
5945 | 31 |
51919
d51ac8d52e63
(Byte Compilation): Explain no-byte-compile
Richard M. Stallman <rms@gnu.org>
parents:
49600
diff
changeset
|
32 @vindex no-byte-compile |
d51ac8d52e63
(Byte Compilation): Explain no-byte-compile
Richard M. Stallman <rms@gnu.org>
parents:
49600
diff
changeset
|
33 If you do not want a Lisp file to be compiled, ever, put a file-local |
d51ac8d52e63
(Byte Compilation): Explain no-byte-compile
Richard M. Stallman <rms@gnu.org>
parents:
49600
diff
changeset
|
34 variable binding for @code{no-byte-compile} into it, like this: |
d51ac8d52e63
(Byte Compilation): Explain no-byte-compile
Richard M. Stallman <rms@gnu.org>
parents:
49600
diff
changeset
|
35 |
d51ac8d52e63
(Byte Compilation): Explain no-byte-compile
Richard M. Stallman <rms@gnu.org>
parents:
49600
diff
changeset
|
36 @example |
d51ac8d52e63
(Byte Compilation): Explain no-byte-compile
Richard M. Stallman <rms@gnu.org>
parents:
49600
diff
changeset
|
37 ;; -*-no-byte-compile: t; -*- |
d51ac8d52e63
(Byte Compilation): Explain no-byte-compile
Richard M. Stallman <rms@gnu.org>
parents:
49600
diff
changeset
|
38 @end example |
d51ac8d52e63
(Byte Compilation): Explain no-byte-compile
Richard M. Stallman <rms@gnu.org>
parents:
49600
diff
changeset
|
39 |
5945 | 40 @xref{Compilation Errors}, for how to investigate errors occurring in |
41 byte compilation. | |
42 | |
43 @menu | |
6452
8c7032348e93
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
5945
diff
changeset
|
44 * Speed of Byte-Code:: An example of speedup from byte compilation. |
5945 | 45 * Compilation Functions:: Byte compilation functions. |
12067 | 46 * Docs and Compilation:: Dynamic loading of documentation strings. |
47 * Dynamic Loading:: Dynamic loading of individual functions. | |
5945 | 48 * Eval During Compile:: Code to be evaluated when you compile. |
51919
d51ac8d52e63
(Byte Compilation): Explain no-byte-compile
Richard M. Stallman <rms@gnu.org>
parents:
49600
diff
changeset
|
49 * Compiler Errors:: Handling compiler error messages. |
5945 | 50 * Byte-Code Objects:: The data type used for byte-compiled functions. |
51 * Disassembly:: Disassembling byte-code; how to read byte-code. | |
52 @end menu | |
53 | |
6452
8c7032348e93
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
5945
diff
changeset
|
54 @node Speed of Byte-Code |
8c7032348e93
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
5945
diff
changeset
|
55 @section Performance of Byte-Compiled Code |
8c7032348e93
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
5945
diff
changeset
|
56 |
8c7032348e93
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
5945
diff
changeset
|
57 A byte-compiled function is not as efficient as a primitive function |
8c7032348e93
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
5945
diff
changeset
|
58 written in C, but runs much faster than the version written in Lisp. |
8c7032348e93
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
5945
diff
changeset
|
59 Here is an example: |
8c7032348e93
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
5945
diff
changeset
|
60 |
8c7032348e93
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
5945
diff
changeset
|
61 @example |
8c7032348e93
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
5945
diff
changeset
|
62 @group |
8c7032348e93
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
5945
diff
changeset
|
63 (defun silly-loop (n) |
8c7032348e93
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
5945
diff
changeset
|
64 "Return time before and after N iterations of a loop." |
8c7032348e93
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
5945
diff
changeset
|
65 (let ((t1 (current-time-string))) |
49600
23a1cea22d13
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
38160
diff
changeset
|
66 (while (> (setq n (1- n)) |
6452
8c7032348e93
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
5945
diff
changeset
|
67 0)) |
8c7032348e93
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
5945
diff
changeset
|
68 (list t1 (current-time-string)))) |
8c7032348e93
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
5945
diff
changeset
|
69 @result{} silly-loop |
8c7032348e93
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
5945
diff
changeset
|
70 @end group |
8c7032348e93
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
5945
diff
changeset
|
71 |
8c7032348e93
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
5945
diff
changeset
|
72 @group |
8c7032348e93
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
5945
diff
changeset
|
73 (silly-loop 100000) |
8c7032348e93
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
5945
diff
changeset
|
74 @result{} ("Fri Mar 18 17:25:57 1994" |
8c7032348e93
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
5945
diff
changeset
|
75 "Fri Mar 18 17:26:28 1994") ; @r{31 seconds} |
8c7032348e93
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
5945
diff
changeset
|
76 @end group |
8c7032348e93
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
5945
diff
changeset
|
77 |
8c7032348e93
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
5945
diff
changeset
|
78 @group |
8c7032348e93
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
5945
diff
changeset
|
79 (byte-compile 'silly-loop) |
8c7032348e93
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
5945
diff
changeset
|
80 @result{} @r{[Compiled code not shown]} |
8c7032348e93
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
5945
diff
changeset
|
81 @end group |
8c7032348e93
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
5945
diff
changeset
|
82 |
8c7032348e93
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
5945
diff
changeset
|
83 @group |
8c7032348e93
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
5945
diff
changeset
|
84 (silly-loop 100000) |
8c7032348e93
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
5945
diff
changeset
|
85 @result{} ("Fri Mar 18 17:26:52 1994" |
8c7032348e93
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
5945
diff
changeset
|
86 "Fri Mar 18 17:26:58 1994") ; @r{6 seconds} |
8c7032348e93
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
5945
diff
changeset
|
87 @end group |
8c7032348e93
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
5945
diff
changeset
|
88 @end example |
8c7032348e93
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
5945
diff
changeset
|
89 |
8c7032348e93
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
5945
diff
changeset
|
90 In this example, the interpreted code required 31 seconds to run, |
8c7032348e93
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
5945
diff
changeset
|
91 whereas the byte-compiled code required 6 seconds. These results are |
8c7032348e93
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
5945
diff
changeset
|
92 representative, but actual results will vary greatly. |
8c7032348e93
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
5945
diff
changeset
|
93 |
5945 | 94 @node Compilation Functions |
95 @comment node-name, next, previous, up | |
96 @section The Compilation Functions | |
97 @cindex compilation functions | |
98 | |
99 You can byte-compile an individual function or macro definition with | |
100 the @code{byte-compile} function. You can compile a whole file with | |
101 @code{byte-compile-file}, or several files with | |
102 @code{byte-recompile-directory} or @code{batch-byte-compile}. | |
103 | |
16736
981e116b4ac6
Minor cleanups for overfull hboxes.
Richard M. Stallman <rms@gnu.org>
parents:
12128
diff
changeset
|
104 The byte compiler produces error messages and warnings about each file |
981e116b4ac6
Minor cleanups for overfull hboxes.
Richard M. Stallman <rms@gnu.org>
parents:
12128
diff
changeset
|
105 in a buffer called @samp{*Compile-Log*}. These report things in your |
981e116b4ac6
Minor cleanups for overfull hboxes.
Richard M. Stallman <rms@gnu.org>
parents:
12128
diff
changeset
|
106 program that suggest a problem but are not necessarily erroneous. |
5945 | 107 |
108 @cindex macro compilation | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
109 Be careful when writing macro calls in files that you may someday |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
110 byte-compile. Macro calls are expanded when they are compiled, so the |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
111 macros must already be defined for proper compilation. For more |
38160
05a836654c88
(Compilation Functions): Add xref to Problems with Macros.
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
112 details, see @ref{Compiling Macros}. If a program does not work the |
05a836654c88
(Compilation Functions): Add xref to Problems with Macros.
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
113 same way when compiled as it does when interpreted, erroneous macro |
05a836654c88
(Compilation Functions): Add xref to Problems with Macros.
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
114 definitions are one likely cause (@pxref{Problems with Macros}). |
60036
fafa7c0e2b82
(Byte Compilation): Delete 19.29 info.
Richard M. Stallman <rms@gnu.org>
parents:
55733
diff
changeset
|
115 Inline (@code{defsubst}) functions are less troublesome; if you |
fafa7c0e2b82
(Byte Compilation): Delete 19.29 info.
Richard M. Stallman <rms@gnu.org>
parents:
55733
diff
changeset
|
116 compile a call to such a function before its definition is known, the |
fafa7c0e2b82
(Byte Compilation): Delete 19.29 info.
Richard M. Stallman <rms@gnu.org>
parents:
55733
diff
changeset
|
117 call will still work right, it will just run slower. |
5945 | 118 |
6452
8c7032348e93
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
5945
diff
changeset
|
119 Normally, compiling a file does not evaluate the file's contents or |
12098 | 120 load the file. But it does execute any @code{require} calls at top |
121 level in the file. One way to ensure that necessary macro definitions | |
122 are available during compilation is to require the file that defines | |
123 them (@pxref{Named Features}). To avoid loading the macro definition files | |
124 when someone @emph{runs} the compiled program, write | |
125 @code{eval-when-compile} around the @code{require} calls (@pxref{Eval | |
126 During Compile}). | |
5945 | 127 |
128 @defun byte-compile symbol | |
6452
8c7032348e93
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
5945
diff
changeset
|
129 This function byte-compiles the function definition of @var{symbol}, |
5945 | 130 replacing the previous definition with the compiled one. The function |
131 definition of @var{symbol} must be the actual code for the function; | |
132 i.e., the compiler does not follow indirection to another symbol. | |
6452
8c7032348e93
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
5945
diff
changeset
|
133 @code{byte-compile} returns the new, compiled definition of |
8c7032348e93
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
5945
diff
changeset
|
134 @var{symbol}. |
8c7032348e93
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
5945
diff
changeset
|
135 |
12067 | 136 If @var{symbol}'s definition is a byte-code function object, |
6452
8c7032348e93
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
5945
diff
changeset
|
137 @code{byte-compile} does nothing and returns @code{nil}. Lisp records |
8c7032348e93
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
5945
diff
changeset
|
138 only one function definition for any symbol, and if that is already |
8c7032348e93
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
5945
diff
changeset
|
139 compiled, non-compiled code is not available anywhere. So there is no |
8c7032348e93
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
5945
diff
changeset
|
140 way to ``compile the same definition again.'' |
5945 | 141 |
142 @example | |
143 @group | |
144 (defun factorial (integer) | |
145 "Compute factorial of INTEGER." | |
146 (if (= 1 integer) 1 | |
147 (* integer (factorial (1- integer))))) | |
6452
8c7032348e93
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
5945
diff
changeset
|
148 @result{} factorial |
5945 | 149 @end group |
150 | |
151 @group | |
152 (byte-compile 'factorial) | |
6452
8c7032348e93
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
5945
diff
changeset
|
153 @result{} |
5945 | 154 #[(integer) |
155 "^H\301U\203^H^@@\301\207\302^H\303^HS!\"\207" | |
156 [integer 1 * factorial] | |
157 4 "Compute factorial of INTEGER."] | |
158 @end group | |
159 @end example | |
160 | |
161 @noindent | |
6452
8c7032348e93
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
5945
diff
changeset
|
162 The result is a byte-code function object. The string it contains is |
8c7032348e93
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
5945
diff
changeset
|
163 the actual byte-code; each character in it is an instruction or an |
8c7032348e93
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
5945
diff
changeset
|
164 operand of an instruction. The vector contains all the constants, |
8c7032348e93
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
5945
diff
changeset
|
165 variable names and function names used by the function, except for |
8c7032348e93
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
5945
diff
changeset
|
166 certain primitives that are coded as special instructions. |
55733 | 167 |
168 If the argument to @code{byte-compile} is a @code{lambda} expression, | |
169 it returns the corresponding compiled code, but does not store | |
170 it anywhere. | |
5945 | 171 @end defun |
172 | |
53585
aaa866b1592f
(Compilation Functions): Expand descriptions of `compile-defun',
Luc Teirlinck <teirllm@auburn.edu>
parents:
52401
diff
changeset
|
173 @deffn Command compile-defun &optional arg |
5945 | 174 This command reads the defun containing point, compiles it, and |
175 evaluates the result. If you use this on a defun that is actually a | |
176 function definition, the effect is to install a compiled version of that | |
177 function. | |
53585
aaa866b1592f
(Compilation Functions): Expand descriptions of `compile-defun',
Luc Teirlinck <teirllm@auburn.edu>
parents:
52401
diff
changeset
|
178 |
aaa866b1592f
(Compilation Functions): Expand descriptions of `compile-defun',
Luc Teirlinck <teirllm@auburn.edu>
parents:
52401
diff
changeset
|
179 @code{compile-defun} normally displays the result of evaluation in the |
aaa866b1592f
(Compilation Functions): Expand descriptions of `compile-defun',
Luc Teirlinck <teirllm@auburn.edu>
parents:
52401
diff
changeset
|
180 echo area, but if @var{arg} is non-@code{nil}, it inserts the result |
aaa866b1592f
(Compilation Functions): Expand descriptions of `compile-defun',
Luc Teirlinck <teirllm@auburn.edu>
parents:
52401
diff
changeset
|
181 in the current buffer after the form it compiled. |
5945 | 182 @end deffn |
183 | |
53585
aaa866b1592f
(Compilation Functions): Expand descriptions of `compile-defun',
Luc Teirlinck <teirllm@auburn.edu>
parents:
52401
diff
changeset
|
184 @deffn Command byte-compile-file filename &optional load |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
185 This function compiles a file of Lisp code named @var{filename} into a |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
186 file of byte-code. The output file's name is made by changing the |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
187 @samp{.el} suffix into @samp{.elc}; if @var{filename} does not end in |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
188 @samp{.el}, it adds @samp{.elc} to the end of @var{filename}. |
5945 | 189 |
6452
8c7032348e93
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
5945
diff
changeset
|
190 Compilation works by reading the input file one form at a time. If it |
5945 | 191 is a definition of a function or macro, the compiled function or macro |
192 definition is written out. Other forms are batched together, then each | |
193 batch is compiled, and written so that its compiled code will be | |
194 executed when the file is read. All comments are discarded when the | |
195 input file is read. | |
196 | |
53585
aaa866b1592f
(Compilation Functions): Expand descriptions of `compile-defun',
Luc Teirlinck <teirllm@auburn.edu>
parents:
52401
diff
changeset
|
197 This command returns @code{t} if there were no errors and @code{nil} |
aaa866b1592f
(Compilation Functions): Expand descriptions of `compile-defun',
Luc Teirlinck <teirllm@auburn.edu>
parents:
52401
diff
changeset
|
198 otherwise. When called interactively, it prompts for the file name. |
aaa866b1592f
(Compilation Functions): Expand descriptions of `compile-defun',
Luc Teirlinck <teirllm@auburn.edu>
parents:
52401
diff
changeset
|
199 |
aaa866b1592f
(Compilation Functions): Expand descriptions of `compile-defun',
Luc Teirlinck <teirllm@auburn.edu>
parents:
52401
diff
changeset
|
200 If @var{load} is non-@code{nil}, this command loads the compiled file |
aaa866b1592f
(Compilation Functions): Expand descriptions of `compile-defun',
Luc Teirlinck <teirllm@auburn.edu>
parents:
52401
diff
changeset
|
201 after compiling it. Interactively, @var{load} is the prefix argument. |
5945 | 202 |
203 @example | |
204 @group | |
205 % ls -l push* | |
206 -rw-r--r-- 1 lewis 791 Oct 5 20:31 push.el | |
207 @end group | |
208 | |
209 @group | |
210 (byte-compile-file "~/emacs/push.el") | |
211 @result{} t | |
212 @end group | |
213 | |
214 @group | |
215 % ls -l push* | |
216 -rw-r--r-- 1 lewis 791 Oct 5 20:31 push.el | |
217 -rw-rw-rw- 1 lewis 638 Oct 8 20:25 push.elc | |
218 @end group | |
219 @end example | |
220 @end deffn | |
221 | |
53585
aaa866b1592f
(Compilation Functions): Expand descriptions of `compile-defun',
Luc Teirlinck <teirllm@auburn.edu>
parents:
52401
diff
changeset
|
222 @deffn Command byte-recompile-directory directory &optional flag force |
5945 | 223 @cindex library compilation |
53585
aaa866b1592f
(Compilation Functions): Expand descriptions of `compile-defun',
Luc Teirlinck <teirllm@auburn.edu>
parents:
52401
diff
changeset
|
224 This command recompiles every @samp{.el} file in @var{directory} (or |
aaa866b1592f
(Compilation Functions): Expand descriptions of `compile-defun',
Luc Teirlinck <teirllm@auburn.edu>
parents:
52401
diff
changeset
|
225 its subdirectories) that needs recompilation. A file needs |
aaa866b1592f
(Compilation Functions): Expand descriptions of `compile-defun',
Luc Teirlinck <teirllm@auburn.edu>
parents:
52401
diff
changeset
|
226 recompilation if a @samp{.elc} file exists but is older than the |
aaa866b1592f
(Compilation Functions): Expand descriptions of `compile-defun',
Luc Teirlinck <teirllm@auburn.edu>
parents:
52401
diff
changeset
|
227 @samp{.el} file. |
5945 | 228 |
53585
aaa866b1592f
(Compilation Functions): Expand descriptions of `compile-defun',
Luc Teirlinck <teirllm@auburn.edu>
parents:
52401
diff
changeset
|
229 When a @samp{.el} file has no corresponding @samp{.elc} file, |
aaa866b1592f
(Compilation Functions): Expand descriptions of `compile-defun',
Luc Teirlinck <teirllm@auburn.edu>
parents:
52401
diff
changeset
|
230 @var{flag} says what to do. If it is @code{nil}, this command ignores |
aaa866b1592f
(Compilation Functions): Expand descriptions of `compile-defun',
Luc Teirlinck <teirllm@auburn.edu>
parents:
52401
diff
changeset
|
231 these files. If @var{flag} is 0, it compiles them. If it is neither |
55733 | 232 @code{nil} nor 0, it asks the user whether to compile each such file, |
233 and asks about each subdirectory as well. | |
5945 | 234 |
53585
aaa866b1592f
(Compilation Functions): Expand descriptions of `compile-defun',
Luc Teirlinck <teirllm@auburn.edu>
parents:
52401
diff
changeset
|
235 Interactively, @code{byte-recompile-directory} prompts for |
aaa866b1592f
(Compilation Functions): Expand descriptions of `compile-defun',
Luc Teirlinck <teirllm@auburn.edu>
parents:
52401
diff
changeset
|
236 @var{directory} and @var{flag} is the prefix argument. |
aaa866b1592f
(Compilation Functions): Expand descriptions of `compile-defun',
Luc Teirlinck <teirllm@auburn.edu>
parents:
52401
diff
changeset
|
237 |
aaa866b1592f
(Compilation Functions): Expand descriptions of `compile-defun',
Luc Teirlinck <teirllm@auburn.edu>
parents:
52401
diff
changeset
|
238 If @var{force} is non-@code{nil}, this command recompiles every |
aaa866b1592f
(Compilation Functions): Expand descriptions of `compile-defun',
Luc Teirlinck <teirllm@auburn.edu>
parents:
52401
diff
changeset
|
239 @samp{.el} file that has a @samp{.elc} file. |
aaa866b1592f
(Compilation Functions): Expand descriptions of `compile-defun',
Luc Teirlinck <teirllm@auburn.edu>
parents:
52401
diff
changeset
|
240 |
aaa866b1592f
(Compilation Functions): Expand descriptions of `compile-defun',
Luc Teirlinck <teirllm@auburn.edu>
parents:
52401
diff
changeset
|
241 The returned value is unpredictable. |
5945 | 242 @end deffn |
243 | |
53585
aaa866b1592f
(Compilation Functions): Expand descriptions of `compile-defun',
Luc Teirlinck <teirllm@auburn.edu>
parents:
52401
diff
changeset
|
244 @defun batch-byte-compile &optional noforce |
6452
8c7032348e93
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
5945
diff
changeset
|
245 This function runs @code{byte-compile-file} on files specified on the |
8c7032348e93
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
5945
diff
changeset
|
246 command line. This function must be used only in a batch execution of |
8c7032348e93
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
5945
diff
changeset
|
247 Emacs, as it kills Emacs on completion. An error in one file does not |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
248 prevent processing of subsequent files, but no output file will be |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
249 generated for it, and the Emacs process will terminate with a nonzero |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
250 status code. |
5945 | 251 |
53585
aaa866b1592f
(Compilation Functions): Expand descriptions of `compile-defun',
Luc Teirlinck <teirllm@auburn.edu>
parents:
52401
diff
changeset
|
252 If @var{noforce} is non-@code{nil}, this function does not recompile |
aaa866b1592f
(Compilation Functions): Expand descriptions of `compile-defun',
Luc Teirlinck <teirllm@auburn.edu>
parents:
52401
diff
changeset
|
253 files that have an up-to-date @samp{.elc} file. |
aaa866b1592f
(Compilation Functions): Expand descriptions of `compile-defun',
Luc Teirlinck <teirllm@auburn.edu>
parents:
52401
diff
changeset
|
254 |
5945 | 255 @example |
256 % emacs -batch -f batch-byte-compile *.el | |
257 @end example | |
258 @end defun | |
259 | |
260 @defun byte-code code-string data-vector max-stack | |
261 @cindex byte-code interpreter | |
6452
8c7032348e93
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
5945
diff
changeset
|
262 This function actually interprets byte-code. A byte-compiled function |
5945 | 263 is actually defined with a body that calls @code{byte-code}. Don't call |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
264 this function yourself---only the byte compiler knows how to generate |
5945 | 265 valid calls to this function. |
266 | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
267 In Emacs version 18, byte-code was always executed by way of a call to |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
268 the function @code{byte-code}. Nowadays, byte-code is usually executed |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
269 as part of a byte-code function object, and only rarely through an |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
270 explicit call to @code{byte-code}. |
5945 | 271 @end defun |
272 | |
12067 | 273 @node Docs and Compilation |
274 @section Documentation Strings and Compilation | |
275 @cindex dynamic loading of documentation | |
276 | |
277 Functions and variables loaded from a byte-compiled file access their | |
278 documentation strings dynamically from the file whenever needed. This | |
12128
27144f55d1c6
fixed errors that appeared during update to 19.29.
Melissa Weisshaus <melissa@gnu.org>
parents:
12124
diff
changeset
|
279 saves space within Emacs, and makes loading faster because the |
12067 | 280 documentation strings themselves need not be processed while loading the |
281 file. Actual access to the documentation strings becomes slower as a | |
282 result, but this normally is not enough to bother users. | |
283 | |
284 Dynamic access to documentation strings does have drawbacks: | |
285 | |
286 @itemize @bullet | |
287 @item | |
288 If you delete or move the compiled file after loading it, Emacs can no | |
289 longer access the documentation strings for the functions and variables | |
290 in the file. | |
291 | |
292 @item | |
293 If you alter the compiled file (such as by compiling a new version), | |
55733 | 294 then further access to documentation strings in this file will |
295 probably give nonsense results. | |
12067 | 296 @end itemize |
297 | |
298 If your site installs Emacs following the usual procedures, these | |
299 problems will never normally occur. Installing a new version uses a new | |
300 directory with a different name; as long as the old version remains | |
301 installed, its files will remain unmodified in the places where they are | |
302 expected to be. | |
303 | |
12124 | 304 However, if you have built Emacs yourself and use it from the |
12067 | 305 directory where you built it, you will experience this problem |
306 occasionally if you edit and recompile Lisp files. When it happens, you | |
307 can cure the problem by reloading the file after recompiling it. | |
308 | |
60036
fafa7c0e2b82
(Byte Compilation): Delete 19.29 info.
Richard M. Stallman <rms@gnu.org>
parents:
55733
diff
changeset
|
309 You can turn off this feature at compile time by setting |
fafa7c0e2b82
(Byte Compilation): Delete 19.29 info.
Richard M. Stallman <rms@gnu.org>
parents:
55733
diff
changeset
|
310 @code{byte-compile-dynamic-docstrings} to @code{nil}; this is useful |
fafa7c0e2b82
(Byte Compilation): Delete 19.29 info.
Richard M. Stallman <rms@gnu.org>
parents:
55733
diff
changeset
|
311 mainly if you expect to change the file, and you want Emacs processes |
fafa7c0e2b82
(Byte Compilation): Delete 19.29 info.
Richard M. Stallman <rms@gnu.org>
parents:
55733
diff
changeset
|
312 that have already loaded it to keep working when the file changes. |
fafa7c0e2b82
(Byte Compilation): Delete 19.29 info.
Richard M. Stallman <rms@gnu.org>
parents:
55733
diff
changeset
|
313 You can do this globally, or for one source file by specifying a |
fafa7c0e2b82
(Byte Compilation): Delete 19.29 info.
Richard M. Stallman <rms@gnu.org>
parents:
55733
diff
changeset
|
314 file-local binding for the variable. One way to do that is by adding |
fafa7c0e2b82
(Byte Compilation): Delete 19.29 info.
Richard M. Stallman <rms@gnu.org>
parents:
55733
diff
changeset
|
315 this string to the file's first line: |
12067 | 316 |
317 @example | |
318 -*-byte-compile-dynamic-docstrings: nil;-*- | |
319 @end example | |
320 | |
321 @defvar byte-compile-dynamic-docstrings | |
322 If this is non-@code{nil}, the byte compiler generates compiled files | |
323 that are set up for dynamic loading of documentation strings. | |
324 @end defvar | |
325 | |
326 @cindex @samp{#@@@var{count}} | |
327 @cindex @samp{#$} | |
328 The dynamic documentation string feature writes compiled files that | |
329 use a special Lisp reader construct, @samp{#@@@var{count}}. This | |
330 construct skips the next @var{count} characters. It also uses the | |
331 @samp{#$} construct, which stands for ``the name of this file, as a | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
332 string.'' It is usually best not to use these constructs in Lisp source |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
333 files, since they are not designed to be clear to humans reading the |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
334 file. |
12067 | 335 |
336 @node Dynamic Loading | |
337 @section Dynamic Loading of Individual Functions | |
338 | |
339 @cindex dynamic loading of functions | |
340 @cindex lazy loading | |
341 When you compile a file, you can optionally enable the @dfn{dynamic | |
342 function loading} feature (also known as @dfn{lazy loading}). With | |
343 dynamic function loading, loading the file doesn't fully read the | |
344 function definitions in the file. Instead, each function definition | |
345 contains a place-holder which refers to the file. The first time each | |
346 function is called, it reads the full definition from the file, to | |
347 replace the place-holder. | |
348 | |
349 The advantage of dynamic function loading is that loading the file | |
350 becomes much faster. This is a good thing for a file which contains | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
351 many separate user-callable functions, if using one of them does not |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
352 imply you will probably also use the rest. A specialized mode which |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
353 provides many keyboard commands often has that usage pattern: a user may |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
354 invoke the mode, but use only a few of the commands it provides. |
12067 | 355 |
356 The dynamic loading feature has certain disadvantages: | |
357 | |
358 @itemize @bullet | |
359 @item | |
360 If you delete or move the compiled file after loading it, Emacs can no | |
361 longer load the remaining function definitions not already loaded. | |
362 | |
363 @item | |
364 If you alter the compiled file (such as by compiling a new version), | |
55733 | 365 then trying to load any function not already loaded will usually yield |
366 nonsense results. | |
12067 | 367 @end itemize |
368 | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
369 These problems will never happen in normal circumstances with |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
370 installed Emacs files. But they are quite likely to happen with Lisp |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
371 files that you are changing. The easiest way to prevent these problems |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
372 is to reload the new compiled file immediately after each recompilation. |
12067 | 373 |
374 The byte compiler uses the dynamic function loading feature if the | |
375 variable @code{byte-compile-dynamic} is non-@code{nil} at compilation | |
376 time. Do not set this variable globally, since dynamic loading is | |
377 desirable only for certain files. Instead, enable the feature for | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
378 specific source files with file-local variable bindings. For example, |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
379 you could do it by writing this text in the source file's first line: |
12067 | 380 |
381 @example | |
382 -*-byte-compile-dynamic: t;-*- | |
383 @end example | |
384 | |
385 @defvar byte-compile-dynamic | |
386 If this is non-@code{nil}, the byte compiler generates compiled files | |
387 that are set up for dynamic function loading. | |
388 @end defvar | |
389 | |
390 @defun fetch-bytecode function | |
55733 | 391 If @var{function} is a byte-code function object, this immediately |
392 finishes loading the byte code of @var{function} from its | |
393 byte-compiled file, if it is not fully loaded already. Otherwise, | |
394 it does nothing. It always returns @var{function}. | |
12067 | 395 @end defun |
396 | |
5945 | 397 @node Eval During Compile |
398 @section Evaluation During Compilation | |
399 | |
12067 | 400 These features permit you to write code to be evaluated during |
5945 | 401 compilation of a program. |
402 | |
403 @defspec eval-and-compile body | |
404 This form marks @var{body} to be evaluated both when you compile the | |
405 containing code and when you run it (whether compiled or not). | |
406 | |
407 You can get a similar result by putting @var{body} in a separate file | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
408 and referring to that file with @code{require}. That method is |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
409 preferable when @var{body} is large. |
5945 | 410 @end defspec |
411 | |
412 @defspec eval-when-compile body | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
413 This form marks @var{body} to be evaluated at compile time but not when |
7212 | 414 the compiled program is loaded. The result of evaluation by the |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
415 compiler becomes a constant which appears in the compiled program. If |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
416 you load the source file, rather than compiling it, @var{body} is |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
417 evaluated normally. |
5945 | 418 |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
419 @strong{Common Lisp Note:} At top level, this is analogous to the Common |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
420 Lisp idiom @code{(eval-when (compile eval) @dots{})}. Elsewhere, the |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
421 Common Lisp @samp{#.} reader macro (but not when interpreting) is closer |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
422 to what @code{eval-when-compile} does. |
5945 | 423 @end defspec |
424 | |
51919
d51ac8d52e63
(Byte Compilation): Explain no-byte-compile
Richard M. Stallman <rms@gnu.org>
parents:
49600
diff
changeset
|
425 @node Compiler Errors |
d51ac8d52e63
(Byte Compilation): Explain no-byte-compile
Richard M. Stallman <rms@gnu.org>
parents:
49600
diff
changeset
|
426 @section Compiler Errors |
d51ac8d52e63
(Byte Compilation): Explain no-byte-compile
Richard M. Stallman <rms@gnu.org>
parents:
49600
diff
changeset
|
427 @cindex compiler errors |
d51ac8d52e63
(Byte Compilation): Explain no-byte-compile
Richard M. Stallman <rms@gnu.org>
parents:
49600
diff
changeset
|
428 |
63583
99e9892a51d9
Fix formatting ugliness.
Richard M. Stallman <rms@gnu.org>
parents:
60036
diff
changeset
|
429 Byte compilation outputs all errors and warnings into the buffer |
51919
d51ac8d52e63
(Byte Compilation): Explain no-byte-compile
Richard M. Stallman <rms@gnu.org>
parents:
49600
diff
changeset
|
430 @samp{*Compile-Log*}. The messages include file names and line |
d51ac8d52e63
(Byte Compilation): Explain no-byte-compile
Richard M. Stallman <rms@gnu.org>
parents:
49600
diff
changeset
|
431 numbers that identify the location of the problem. The usual Emacs |
d51ac8d52e63
(Byte Compilation): Explain no-byte-compile
Richard M. Stallman <rms@gnu.org>
parents:
49600
diff
changeset
|
432 commands for operating on compiler diagnostics work properly on |
d51ac8d52e63
(Byte Compilation): Explain no-byte-compile
Richard M. Stallman <rms@gnu.org>
parents:
49600
diff
changeset
|
433 these messages. |
d51ac8d52e63
(Byte Compilation): Explain no-byte-compile
Richard M. Stallman <rms@gnu.org>
parents:
49600
diff
changeset
|
434 |
d51ac8d52e63
(Byte Compilation): Explain no-byte-compile
Richard M. Stallman <rms@gnu.org>
parents:
49600
diff
changeset
|
435 However, the warnings about functions that were used but not |
d51ac8d52e63
(Byte Compilation): Explain no-byte-compile
Richard M. Stallman <rms@gnu.org>
parents:
49600
diff
changeset
|
436 defined are always ``located'' at the end of the file, so these |
d51ac8d52e63
(Byte Compilation): Explain no-byte-compile
Richard M. Stallman <rms@gnu.org>
parents:
49600
diff
changeset
|
437 commands won't find the places they are really used. To do that, |
d51ac8d52e63
(Byte Compilation): Explain no-byte-compile
Richard M. Stallman <rms@gnu.org>
parents:
49600
diff
changeset
|
438 you must search for the function names. |
53585
aaa866b1592f
(Compilation Functions): Expand descriptions of `compile-defun',
Luc Teirlinck <teirllm@auburn.edu>
parents:
52401
diff
changeset
|
439 |
52139
6a00e88ede75
(Compiler Errors): Explain with-no-warnings
Richard M. Stallman <rms@gnu.org>
parents:
51919
diff
changeset
|
440 You can suppress the compiler warning for calling an undefined |
55733 | 441 function @var{func} by conditionalizing the function call on an |
52139
6a00e88ede75
(Compiler Errors): Explain with-no-warnings
Richard M. Stallman <rms@gnu.org>
parents:
51919
diff
changeset
|
442 @code{fboundp} test, like this: |
6a00e88ede75
(Compiler Errors): Explain with-no-warnings
Richard M. Stallman <rms@gnu.org>
parents:
51919
diff
changeset
|
443 |
6a00e88ede75
(Compiler Errors): Explain with-no-warnings
Richard M. Stallman <rms@gnu.org>
parents:
51919
diff
changeset
|
444 @example |
6a00e88ede75
(Compiler Errors): Explain with-no-warnings
Richard M. Stallman <rms@gnu.org>
parents:
51919
diff
changeset
|
445 (if (fboundp '@var{func}) ...(@var{func} ...)...) |
6a00e88ede75
(Compiler Errors): Explain with-no-warnings
Richard M. Stallman <rms@gnu.org>
parents:
51919
diff
changeset
|
446 @end example |
6a00e88ede75
(Compiler Errors): Explain with-no-warnings
Richard M. Stallman <rms@gnu.org>
parents:
51919
diff
changeset
|
447 |
6a00e88ede75
(Compiler Errors): Explain with-no-warnings
Richard M. Stallman <rms@gnu.org>
parents:
51919
diff
changeset
|
448 @noindent |
54021
5cd1edd36679
(Compiler Errors): if-boundp feature applies to cond.
Richard M. Stallman <rms@gnu.org>
parents:
53585
diff
changeset
|
449 The call to @var{func} must be in the @var{then-form} of the |
5cd1edd36679
(Compiler Errors): if-boundp feature applies to cond.
Richard M. Stallman <rms@gnu.org>
parents:
53585
diff
changeset
|
450 @code{if}, and @var{func} must appear quoted in the call to |
5cd1edd36679
(Compiler Errors): if-boundp feature applies to cond.
Richard M. Stallman <rms@gnu.org>
parents:
53585
diff
changeset
|
451 @code{fboundp}. (This feature operates for @code{cond} as well.) |
5cd1edd36679
(Compiler Errors): if-boundp feature applies to cond.
Richard M. Stallman <rms@gnu.org>
parents:
53585
diff
changeset
|
452 |
5cd1edd36679
(Compiler Errors): if-boundp feature applies to cond.
Richard M. Stallman <rms@gnu.org>
parents:
53585
diff
changeset
|
453 Likewise, you can suppress a compiler warning for an unbound variable |
52139
6a00e88ede75
(Compiler Errors): Explain with-no-warnings
Richard M. Stallman <rms@gnu.org>
parents:
51919
diff
changeset
|
454 @var{variable} by conditionalizing its use on a @code{boundp} test, |
6a00e88ede75
(Compiler Errors): Explain with-no-warnings
Richard M. Stallman <rms@gnu.org>
parents:
51919
diff
changeset
|
455 like this: |
6a00e88ede75
(Compiler Errors): Explain with-no-warnings
Richard M. Stallman <rms@gnu.org>
parents:
51919
diff
changeset
|
456 |
6a00e88ede75
(Compiler Errors): Explain with-no-warnings
Richard M. Stallman <rms@gnu.org>
parents:
51919
diff
changeset
|
457 @example |
6a00e88ede75
(Compiler Errors): Explain with-no-warnings
Richard M. Stallman <rms@gnu.org>
parents:
51919
diff
changeset
|
458 (if (boundp '@var{variable}) ...@var{variable}...) |
6a00e88ede75
(Compiler Errors): Explain with-no-warnings
Richard M. Stallman <rms@gnu.org>
parents:
51919
diff
changeset
|
459 @end example |
6a00e88ede75
(Compiler Errors): Explain with-no-warnings
Richard M. Stallman <rms@gnu.org>
parents:
51919
diff
changeset
|
460 |
6a00e88ede75
(Compiler Errors): Explain with-no-warnings
Richard M. Stallman <rms@gnu.org>
parents:
51919
diff
changeset
|
461 @noindent |
6a00e88ede75
(Compiler Errors): Explain with-no-warnings
Richard M. Stallman <rms@gnu.org>
parents:
51919
diff
changeset
|
462 The reference to @var{variable} must be in the @var{then-form} of the |
6a00e88ede75
(Compiler Errors): Explain with-no-warnings
Richard M. Stallman <rms@gnu.org>
parents:
51919
diff
changeset
|
463 @code{if}, and @var{variable} must appear quoted in the call to |
6a00e88ede75
(Compiler Errors): Explain with-no-warnings
Richard M. Stallman <rms@gnu.org>
parents:
51919
diff
changeset
|
464 @code{boundp}. |
6a00e88ede75
(Compiler Errors): Explain with-no-warnings
Richard M. Stallman <rms@gnu.org>
parents:
51919
diff
changeset
|
465 |
6a00e88ede75
(Compiler Errors): Explain with-no-warnings
Richard M. Stallman <rms@gnu.org>
parents:
51919
diff
changeset
|
466 You can suppress any compiler warnings using the construct |
6a00e88ede75
(Compiler Errors): Explain with-no-warnings
Richard M. Stallman <rms@gnu.org>
parents:
51919
diff
changeset
|
467 @code{with-no-warnings}: |
6a00e88ede75
(Compiler Errors): Explain with-no-warnings
Richard M. Stallman <rms@gnu.org>
parents:
51919
diff
changeset
|
468 |
55733 | 469 @c This is implemented with a defun, but conceptually it is |
470 @c a special form. | |
471 | |
472 @defspec with-no-warnings body... | |
52139
6a00e88ede75
(Compiler Errors): Explain with-no-warnings
Richard M. Stallman <rms@gnu.org>
parents:
51919
diff
changeset
|
473 In execution, this is equivalent to @code{(progn @var{body}...)}, |
6a00e88ede75
(Compiler Errors): Explain with-no-warnings
Richard M. Stallman <rms@gnu.org>
parents:
51919
diff
changeset
|
474 but the compiler does not issue warnings for anything that occurs |
6a00e88ede75
(Compiler Errors): Explain with-no-warnings
Richard M. Stallman <rms@gnu.org>
parents:
51919
diff
changeset
|
475 inside @var{body}. |
6a00e88ede75
(Compiler Errors): Explain with-no-warnings
Richard M. Stallman <rms@gnu.org>
parents:
51919
diff
changeset
|
476 |
6a00e88ede75
(Compiler Errors): Explain with-no-warnings
Richard M. Stallman <rms@gnu.org>
parents:
51919
diff
changeset
|
477 We recommend that you use this construct around the smallest |
6a00e88ede75
(Compiler Errors): Explain with-no-warnings
Richard M. Stallman <rms@gnu.org>
parents:
51919
diff
changeset
|
478 possible piece of code. |
55733 | 479 @end defspec |
52139
6a00e88ede75
(Compiler Errors): Explain with-no-warnings
Richard M. Stallman <rms@gnu.org>
parents:
51919
diff
changeset
|
480 |
5945 | 481 @node Byte-Code Objects |
12098 | 482 @section Byte-Code Function Objects |
5945 | 483 @cindex compiled function |
484 @cindex byte-code function | |
485 | |
486 Byte-compiled functions have a special data type: they are | |
487 @dfn{byte-code function objects}. | |
488 | |
489 Internally, a byte-code function object is much like a vector; | |
490 however, the evaluator handles this data type specially when it appears | |
491 as a function to be called. The printed representation for a byte-code | |
492 function object is like that for a vector, with an additional @samp{#} | |
493 before the opening @samp{[}. | |
494 | |
495 A byte-code function object must have at least four elements; there is | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
496 no maximum number, but only the first six elements have any normal use. |
5945 | 497 They are: |
498 | |
499 @table @var | |
500 @item arglist | |
501 The list of argument symbols. | |
502 | |
503 @item byte-code | |
504 The string containing the byte-code instructions. | |
505 | |
506 @item constants | |
7212 | 507 The vector of Lisp objects referenced by the byte code. These include |
508 symbols used as function names and variable names. | |
5945 | 509 |
510 @item stacksize | |
511 The maximum stack size this function needs. | |
512 | |
513 @item docstring | |
12098 | 514 The documentation string (if any); otherwise, @code{nil}. The value may |
515 be a number or a list, in case the documentation string is stored in a | |
516 file. Use the function @code{documentation} to get the real | |
517 documentation string (@pxref{Accessing Documentation}). | |
5945 | 518 |
519 @item interactive | |
520 The interactive spec (if any). This can be a string or a Lisp | |
521 expression. It is @code{nil} for a function that isn't interactive. | |
522 @end table | |
523 | |
524 Here's an example of a byte-code function object, in printed | |
525 representation. It is the definition of the command | |
526 @code{backward-sexp}. | |
527 | |
528 @example | |
529 #[(&optional arg) | |
530 "^H\204^F^@@\301^P\302^H[!\207" | |
531 [arg 1 forward-sexp] | |
532 2 | |
533 254435 | |
534 "p"] | |
535 @end example | |
536 | |
537 The primitive way to create a byte-code object is with | |
538 @code{make-byte-code}: | |
539 | |
540 @defun make-byte-code &rest elements | |
541 This function constructs and returns a byte-code function object | |
542 with @var{elements} as its elements. | |
543 @end defun | |
544 | |
6452
8c7032348e93
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
5945
diff
changeset
|
545 You should not try to come up with the elements for a byte-code |
8c7032348e93
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
5945
diff
changeset
|
546 function yourself, because if they are inconsistent, Emacs may crash |
7212 | 547 when you call the function. Always leave it to the byte compiler to |
6452
8c7032348e93
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
5945
diff
changeset
|
548 create these objects; it makes the elements consistent (we hope). |
5945 | 549 |
550 You can access the elements of a byte-code object using @code{aref}; | |
551 you can also use @code{vconcat} to create a vector with the same | |
552 elements. | |
553 | |
554 @node Disassembly | |
555 @section Disassembled Byte-Code | |
556 @cindex disassembled byte-code | |
557 | |
558 People do not write byte-code; that job is left to the byte compiler. | |
559 But we provide a disassembler to satisfy a cat-like curiosity. The | |
560 disassembler converts the byte-compiled code into humanly readable | |
561 form. | |
562 | |
563 The byte-code interpreter is implemented as a simple stack machine. | |
6452
8c7032348e93
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
5945
diff
changeset
|
564 It pushes values onto a stack of its own, then pops them off to use them |
7212 | 565 in calculations whose results are themselves pushed back on the stack. |
566 When a byte-code function returns, it pops a value off the stack and | |
567 returns it as the value of the function. | |
5945 | 568 |
7212 | 569 In addition to the stack, byte-code functions can use, bind, and set |
6452
8c7032348e93
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
5945
diff
changeset
|
570 ordinary Lisp variables, by transferring values between variables and |
8c7032348e93
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
5945
diff
changeset
|
571 the stack. |
5945 | 572 |
53585
aaa866b1592f
(Compilation Functions): Expand descriptions of `compile-defun',
Luc Teirlinck <teirllm@auburn.edu>
parents:
52401
diff
changeset
|
573 @deffn Command disassemble object &optional buffer-or-name |
aaa866b1592f
(Compilation Functions): Expand descriptions of `compile-defun',
Luc Teirlinck <teirllm@auburn.edu>
parents:
52401
diff
changeset
|
574 This command displays the disassembled code for @var{object}. In |
aaa866b1592f
(Compilation Functions): Expand descriptions of `compile-defun',
Luc Teirlinck <teirllm@auburn.edu>
parents:
52401
diff
changeset
|
575 interactive use, or if @var{buffer-or-name} is @code{nil} or omitted, |
aaa866b1592f
(Compilation Functions): Expand descriptions of `compile-defun',
Luc Teirlinck <teirllm@auburn.edu>
parents:
52401
diff
changeset
|
576 the output goes in a buffer named @samp{*Disassemble*}. If |
aaa866b1592f
(Compilation Functions): Expand descriptions of `compile-defun',
Luc Teirlinck <teirllm@auburn.edu>
parents:
52401
diff
changeset
|
577 @var{buffer-or-name} is non-@code{nil}, it must be a buffer or the |
aaa866b1592f
(Compilation Functions): Expand descriptions of `compile-defun',
Luc Teirlinck <teirllm@auburn.edu>
parents:
52401
diff
changeset
|
578 name of an existing buffer. Then the output goes there, at point, and |
aaa866b1592f
(Compilation Functions): Expand descriptions of `compile-defun',
Luc Teirlinck <teirllm@auburn.edu>
parents:
52401
diff
changeset
|
579 point is left before the output. |
5945 | 580 |
53585
aaa866b1592f
(Compilation Functions): Expand descriptions of `compile-defun',
Luc Teirlinck <teirllm@auburn.edu>
parents:
52401
diff
changeset
|
581 The argument @var{object} can be a function name, a lambda expression |
55733 | 582 or a byte-code object. If it is a lambda expression, @code{disassemble} |
583 compiles it and disassembles the resulting compiled code. | |
5945 | 584 @end deffn |
585 | |
586 Here are two examples of using the @code{disassemble} function. We | |
587 have added explanatory comments to help you relate the byte-code to the | |
588 Lisp source; these do not appear in the output of @code{disassemble}. | |
589 These examples show unoptimized byte-code. Nowadays byte-code is | |
590 usually optimized, but we did not want to rewrite these examples, since | |
591 they still serve their purpose. | |
592 | |
593 @example | |
594 @group | |
595 (defun factorial (integer) | |
596 "Compute factorial of an integer." | |
597 (if (= 1 integer) 1 | |
598 (* integer (factorial (1- integer))))) | |
599 @result{} factorial | |
600 @end group | |
601 | |
602 @group | |
603 (factorial 4) | |
604 @result{} 24 | |
605 @end group | |
606 | |
607 @group | |
608 (disassemble 'factorial) | |
609 @print{} byte-code for factorial: | |
610 doc: Compute factorial of an integer. | |
611 args: (integer) | |
612 @end group | |
613 | |
614 @group | |
615 0 constant 1 ; @r{Push 1 onto stack.} | |
616 | |
49600
23a1cea22d13
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
38160
diff
changeset
|
617 1 varref integer ; @r{Get value of @code{integer}} |
5945 | 618 ; @r{from the environment} |
619 ; @r{and push the value} | |
620 ; @r{onto the stack.} | |
621 @end group | |
622 | |
623 @group | |
624 2 eqlsign ; @r{Pop top two values off stack,} | |
625 ; @r{compare them,} | |
626 ; @r{and push result onto stack.} | |
627 @end group | |
628 | |
629 @group | |
630 3 goto-if-nil 10 ; @r{Pop and test top of stack;} | |
631 ; @r{if @code{nil}, go to 10,} | |
632 ; @r{else continue.} | |
633 @end group | |
634 | |
635 @group | |
636 6 constant 1 ; @r{Push 1 onto top of stack.} | |
637 | |
638 7 goto 17 ; @r{Go to 17 (in this case, 1 will be} | |
639 ; @r{returned by the function).} | |
640 @end group | |
641 | |
642 @group | |
643 10 constant * ; @r{Push symbol @code{*} onto stack.} | |
644 | |
645 11 varref integer ; @r{Push value of @code{integer} onto stack.} | |
646 @end group | |
647 | |
648 @group | |
649 12 constant factorial ; @r{Push @code{factorial} onto stack.} | |
650 | |
651 13 varref integer ; @r{Push value of @code{integer} onto stack.} | |
652 | |
653 14 sub1 ; @r{Pop @code{integer}, decrement value,} | |
654 ; @r{push new value onto stack.} | |
655 @end group | |
656 | |
657 @group | |
658 ; @r{Stack now contains:} | |
659 ; @minus{} @r{decremented value of @code{integer}} | |
49600
23a1cea22d13
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
38160
diff
changeset
|
660 ; @minus{} @r{@code{factorial}} |
5945 | 661 ; @minus{} @r{value of @code{integer}} |
662 ; @minus{} @r{@code{*}} | |
663 @end group | |
664 | |
665 @group | |
666 15 call 1 ; @r{Call function @code{factorial} using} | |
667 ; @r{the first (i.e., the top) element} | |
668 ; @r{of the stack as the argument;} | |
669 ; @r{push returned value onto stack.} | |
670 @end group | |
671 | |
672 @group | |
673 ; @r{Stack now contains:} | |
7212 | 674 ; @minus{} @r{result of recursive} |
5945 | 675 ; @r{call to @code{factorial}} |
676 ; @minus{} @r{value of @code{integer}} | |
677 ; @minus{} @r{@code{*}} | |
678 @end group | |
679 | |
680 @group | |
681 16 call 2 ; @r{Using the first two} | |
682 ; @r{(i.e., the top two)} | |
683 ; @r{elements of the stack} | |
684 ; @r{as arguments,} | |
685 ; @r{call the function @code{*},} | |
686 ; @r{pushing the result onto the stack.} | |
687 @end group | |
688 | |
689 @group | |
690 17 return ; @r{Return the top element} | |
691 ; @r{of the stack.} | |
692 @result{} nil | |
693 @end group | |
694 @end example | |
695 | |
696 The @code{silly-loop} function is somewhat more complex: | |
697 | |
698 @example | |
699 @group | |
700 (defun silly-loop (n) | |
701 "Return time before and after N iterations of a loop." | |
702 (let ((t1 (current-time-string))) | |
49600
23a1cea22d13
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
38160
diff
changeset
|
703 (while (> (setq n (1- n)) |
5945 | 704 0)) |
705 (list t1 (current-time-string)))) | |
706 @result{} silly-loop | |
707 @end group | |
708 | |
709 @group | |
710 (disassemble 'silly-loop) | |
711 @print{} byte-code for silly-loop: | |
712 doc: Return time before and after N iterations of a loop. | |
713 args: (n) | |
714 | |
715 0 constant current-time-string ; @r{Push} | |
716 ; @r{@code{current-time-string}} | |
717 ; @r{onto top of stack.} | |
718 @end group | |
719 | |
720 @group | |
721 1 call 0 ; @r{Call @code{current-time-string}} | |
722 ; @r{ with no argument,} | |
723 ; @r{ pushing result onto stack.} | |
724 @end group | |
725 | |
726 @group | |
727 2 varbind t1 ; @r{Pop stack and bind @code{t1}} | |
728 ; @r{to popped value.} | |
729 @end group | |
730 | |
731 @group | |
732 3 varref n ; @r{Get value of @code{n} from} | |
733 ; @r{the environment and push} | |
734 ; @r{the value onto the stack.} | |
735 @end group | |
736 | |
737 @group | |
738 4 sub1 ; @r{Subtract 1 from top of stack.} | |
739 @end group | |
740 | |
741 @group | |
742 5 dup ; @r{Duplicate the top of the stack;} | |
6452
8c7032348e93
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
5945
diff
changeset
|
743 ; @r{i.e., copy the top of} |
5945 | 744 ; @r{the stack and push the} |
745 ; @r{copy onto the stack.} | |
746 @end group | |
747 | |
748 @group | |
749 6 varset n ; @r{Pop the top of the stack,} | |
750 ; @r{and bind @code{n} to the value.} | |
751 | |
752 ; @r{In effect, the sequence @code{dup varset}} | |
753 ; @r{copies the top of the stack} | |
754 ; @r{into the value of @code{n}} | |
755 ; @r{without popping it.} | |
756 @end group | |
757 | |
758 @group | |
759 7 constant 0 ; @r{Push 0 onto stack.} | |
760 @end group | |
761 | |
762 @group | |
763 8 gtr ; @r{Pop top two values off stack,} | |
764 ; @r{test if @var{n} is greater than 0} | |
765 ; @r{and push result onto stack.} | |
766 @end group | |
767 | |
768 @group | |
7212 | 769 9 goto-if-nil-else-pop 17 ; @r{Goto 17 if @code{n} <= 0} |
770 ; @r{(this exits the while loop).} | |
5945 | 771 ; @r{else pop top of stack} |
772 ; @r{and continue} | |
773 @end group | |
774 | |
775 @group | |
776 12 constant nil ; @r{Push @code{nil} onto stack} | |
777 ; @r{(this is the body of the loop).} | |
778 @end group | |
779 | |
780 @group | |
781 13 discard ; @r{Discard result of the body} | |
782 ; @r{of the loop (a while loop} | |
783 ; @r{is always evaluated for} | |
784 ; @r{its side effects).} | |
785 @end group | |
786 | |
787 @group | |
788 14 goto 3 ; @r{Jump back to beginning} | |
789 ; @r{of while loop.} | |
790 @end group | |
791 | |
792 @group | |
793 17 discard ; @r{Discard result of while loop} | |
794 ; @r{by popping top of stack.} | |
7212 | 795 ; @r{This result is the value @code{nil} that} |
796 ; @r{was not popped by the goto at 9.} | |
5945 | 797 @end group |
798 | |
799 @group | |
800 18 varref t1 ; @r{Push value of @code{t1} onto stack.} | |
801 @end group | |
802 | |
803 @group | |
49600
23a1cea22d13
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
38160
diff
changeset
|
804 19 constant current-time-string ; @r{Push} |
5945 | 805 ; @r{@code{current-time-string}} |
806 ; @r{onto top of stack.} | |
807 @end group | |
808 | |
809 @group | |
810 20 call 0 ; @r{Call @code{current-time-string} again.} | |
811 @end group | |
812 | |
813 @group | |
814 21 list2 ; @r{Pop top two elements off stack,} | |
815 ; @r{create a list of them,} | |
816 ; @r{and push list onto stack.} | |
817 @end group | |
818 | |
819 @group | |
820 22 unbind 1 ; @r{Unbind @code{t1} in local environment.} | |
821 | |
822 23 return ; @r{Return value of the top of stack.} | |
823 | |
824 @result{} nil | |
825 @end group | |
826 @end example | |
827 | |
828 | |
52401 | 829 @ignore |
830 arch-tag: f78e3050-2f0a-4dee-be27-d9979a0a2289 | |
831 @end ignore |