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