annotate lispref/compile.texi @ 56362:f9bb0a7d3c17

*** empty log message ***
author Luc Teirlinck <teirllm@auburn.edu>
date Tue, 06 Jul 2004 17:55:00 +0000
parents 8b5d63bbe285
children fafa7c0e2b82 4c90ffeb71c5
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
5945
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1 @c -*-texinfo-*-
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
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
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
4 @c See the file elisp.texi for copying conditions.
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
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
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
7 @chapter Byte Compilation
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
8 @cindex byte-code
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
9 @cindex compilation
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
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
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
12 in Lisp into a special representation called @dfn{byte-code} that can be
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
13 executed more efficiently. The compiler replaces Lisp function
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
14 definitions with byte-code. When a byte-code function is called, its
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
15 definition is evaluated by the @dfn{byte-code interpreter}.
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
16
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
17 Because the byte-compiled code is evaluated by the byte-code
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
18 interpreter, instead of being executed directly by the machine's
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
19 hardware (as true compiled code is), byte-code is completely
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
20 transportable from machine to machine without recompilation. It is not,
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
21 however, as fast as true compiled code.
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
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
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
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
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
34 @iftex
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
35 @xref{Docs and Compilation}.
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
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
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
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
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
50 @xref{Compilation Errors}, for how to investigate errors occurring in
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
51 byte compilation.
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
52
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
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
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
55 * Compilation Functions:: Byte compilation functions.
12067
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 7212
diff changeset
56 * Docs and Compilation:: Dynamic loading of documentation strings.
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 7212
diff changeset
57 * Dynamic Loading:: Dynamic loading of individual functions.
5945
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
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
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
60 * Byte-Code Objects:: The data type used for byte-compiled functions.
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
61 * Disassembly:: Disassembling byte-code; how to read byte-code.
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
62 @end menu
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
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
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
104 @node Compilation Functions
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
105 @comment node-name, next, previous, up
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
106 @section The Compilation Functions
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
107 @cindex compilation functions
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
108
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
109 You can byte-compile an individual function or macro definition with
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
110 the @code{byte-compile} function. You can compile a whole file with
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
111 @code{byte-compile-file}, or several files with
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
112 @code{byte-recompile-directory} or @code{batch-byte-compile}.
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
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
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
117
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
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
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
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
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
127 load the file. But it does execute any @code{require} calls at top
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
128 level in the file. One way to ensure that necessary macro definitions
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
129 are available during compilation is to require the file that defines
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
130 them (@pxref{Named Features}). To avoid loading the macro definition files
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
131 when someone @emph{runs} the compiled program, write
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
132 @code{eval-when-compile} around the @code{require} calls (@pxref{Eval
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
133 During Compile}).
5945
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
134
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
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
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
137 replacing the previous definition with the compiled one. The function
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
138 definition of @var{symbol} must be the actual code for the function;
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
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
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 7212
diff changeset
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
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
148
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
149 @example
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
150 @group
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
151 (defun factorial (integer)
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
152 "Compute factorial of INTEGER."
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
153 (if (= 1 integer) 1
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
154 (* integer (factorial (1- integer)))))
6452
8c7032348e93 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 5945
diff changeset
155 @result{} factorial
5945
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
156 @end group
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
157
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
158 @group
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
159 (byte-compile 'factorial)
6452
8c7032348e93 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 5945
diff changeset
160 @result{}
5945
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
161 #[(integer)
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
162 "^H\301U\203^H^@@\301\207\302^H\303^HS!\"\207"
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
163 [integer 1 * factorial]
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
164 4 "Compute factorial of INTEGER."]
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
165 @end group
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
166 @end example
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
167
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
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
8b5d63bbe285 Minor cleanups.
Richard M. Stallman <rms@gnu.org>
parents: 54021
diff changeset
174
8b5d63bbe285 Minor cleanups.
Richard M. Stallman <rms@gnu.org>
parents: 54021
diff changeset
175 If the argument to @code{byte-compile} is a @code{lambda} expression,
8b5d63bbe285 Minor cleanups.
Richard M. Stallman <rms@gnu.org>
parents: 54021
diff changeset
176 it returns the corresponding compiled code, but does not store
8b5d63bbe285 Minor cleanups.
Richard M. Stallman <rms@gnu.org>
parents: 54021
diff changeset
177 it anywhere.
5945
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
178 @end defun
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
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
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
181 This command reads the defun containing point, compiles it, and
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
182 evaluates the result. If you use this on a defun that is actually a
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
183 function definition, the effect is to install a compiled version of that
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
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
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
189 @end deffn
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
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
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
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
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
198 is a definition of a function or macro, the compiled function or macro
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
199 definition is written out. Other forms are batched together, then each
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
200 batch is compiled, and written so that its compiled code will be
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
201 executed when the file is read. All comments are discarded when the
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
202 input file is read.
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
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
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
209
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
210 @example
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
211 @group
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
212 % ls -l push*
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
213 -rw-r--r-- 1 lewis 791 Oct 5 20:31 push.el
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
214 @end group
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
215
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
216 @group
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
217 (byte-compile-file "~/emacs/push.el")
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
218 @result{} t
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
219 @end group
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
220
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
221 @group
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
222 % ls -l push*
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
223 -rw-r--r-- 1 lewis 791 Oct 5 20:31 push.el
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
224 -rw-rw-rw- 1 lewis 638 Oct 8 20:25 push.elc
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
225 @end group
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
226 @end example
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
227 @end deffn
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
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
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
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
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
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
8b5d63bbe285 Minor cleanups.
Richard M. Stallman <rms@gnu.org>
parents: 54021
diff changeset
239 @code{nil} nor 0, it asks the user whether to compile each such file,
8b5d63bbe285 Minor cleanups.
Richard M. Stallman <rms@gnu.org>
parents: 54021
diff changeset
240 and asks about each subdirectory as well.
5945
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
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
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
249 @end deffn
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
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
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
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
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
262 @example
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
263 % emacs -batch -f batch-byte-compile *.el
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
264 @end example
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
265 @end defun
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
266
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
267 @defun byte-code code-string data-vector max-stack
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
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
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
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
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
272 valid calls to this function.
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
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
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
278 @end defun
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
279
12067
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 7212
diff changeset
280 @node Docs and Compilation
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 7212
diff changeset
281 @section Documentation Strings and Compilation
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 7212
diff changeset
282 @cindex dynamic loading of documentation
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 7212
diff changeset
283
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 7212
diff changeset
284 Functions and variables loaded from a byte-compiled file access their
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 7212
diff changeset
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
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 7212
diff changeset
287 documentation strings themselves need not be processed while loading the
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 7212
diff changeset
288 file. Actual access to the documentation strings becomes slower as a
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 7212
diff changeset
289 result, but this normally is not enough to bother users.
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 7212
diff changeset
290
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 7212
diff changeset
291 Dynamic access to documentation strings does have drawbacks:
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 7212
diff changeset
292
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 7212
diff changeset
293 @itemize @bullet
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 7212
diff changeset
294 @item
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 7212
diff changeset
295 If you delete or move the compiled file after loading it, Emacs can no
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 7212
diff changeset
296 longer access the documentation strings for the functions and variables
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 7212
diff changeset
297 in the file.
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 7212
diff changeset
298
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 7212
diff changeset
299 @item
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 7212
diff changeset
300 If you alter the compiled file (such as by compiling a new version),
55733
8b5d63bbe285 Minor cleanups.
Richard M. Stallman <rms@gnu.org>
parents: 54021
diff changeset
301 then further access to documentation strings in this file will
8b5d63bbe285 Minor cleanups.
Richard M. Stallman <rms@gnu.org>
parents: 54021
diff changeset
302 probably give nonsense results.
12067
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 7212
diff changeset
303 @end itemize
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 7212
diff changeset
304
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 7212
diff changeset
305 If your site installs Emacs following the usual procedures, these
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 7212
diff changeset
306 problems will never normally occur. Installing a new version uses a new
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 7212
diff changeset
307 directory with a different name; as long as the old version remains
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 7212
diff changeset
308 installed, its files will remain unmodified in the places where they are
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 7212
diff changeset
309 expected to be.
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 7212
diff changeset
310
12124
437eb190e7a7 updated for 19.29.
Melissa Weisshaus <melissa@gnu.org>
parents: 12098
diff changeset
311 However, if you have built Emacs yourself and use it from the
12067
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 7212
diff changeset
312 directory where you built it, you will experience this problem
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 7212
diff changeset
313 occasionally if you edit and recompile Lisp files. When it happens, you
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 7212
diff changeset
314 can cure the problem by reloading the file after recompiling it.
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 7212
diff changeset
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
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 7212
diff changeset
324
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 7212
diff changeset
325 @example
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 7212
diff changeset
326 -*-byte-compile-dynamic-docstrings: nil;-*-
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 7212
diff changeset
327 @end example
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 7212
diff changeset
328
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 7212
diff changeset
329 @defvar byte-compile-dynamic-docstrings
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 7212
diff changeset
330 If this is non-@code{nil}, the byte compiler generates compiled files
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 7212
diff changeset
331 that are set up for dynamic loading of documentation strings.
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 7212
diff changeset
332 @end defvar
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 7212
diff changeset
333
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 7212
diff changeset
334 @cindex @samp{#@@@var{count}}
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 7212
diff changeset
335 @cindex @samp{#$}
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 7212
diff changeset
336 The dynamic documentation string feature writes compiled files that
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 7212
diff changeset
337 use a special Lisp reader construct, @samp{#@@@var{count}}. This
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 7212
diff changeset
338 construct skips the next @var{count} characters. It also uses the
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 7212
diff changeset
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
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 7212
diff changeset
343
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 7212
diff changeset
344 @node Dynamic Loading
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 7212
diff changeset
345 @section Dynamic Loading of Individual Functions
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 7212
diff changeset
346
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 7212
diff changeset
347 @cindex dynamic loading of functions
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 7212
diff changeset
348 @cindex lazy loading
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 7212
diff changeset
349 When you compile a file, you can optionally enable the @dfn{dynamic
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 7212
diff changeset
350 function loading} feature (also known as @dfn{lazy loading}). With
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 7212
diff changeset
351 dynamic function loading, loading the file doesn't fully read the
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 7212
diff changeset
352 function definitions in the file. Instead, each function definition
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 7212
diff changeset
353 contains a place-holder which refers to the file. The first time each
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 7212
diff changeset
354 function is called, it reads the full definition from the file, to
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 7212
diff changeset
355 replace the place-holder.
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 7212
diff changeset
356
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 7212
diff changeset
357 The advantage of dynamic function loading is that loading the file
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 7212
diff changeset
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
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 7212
diff changeset
363
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 7212
diff changeset
364 The dynamic loading feature has certain disadvantages:
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 7212
diff changeset
365
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 7212
diff changeset
366 @itemize @bullet
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 7212
diff changeset
367 @item
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 7212
diff changeset
368 If you delete or move the compiled file after loading it, Emacs can no
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 7212
diff changeset
369 longer load the remaining function definitions not already loaded.
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 7212
diff changeset
370
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 7212
diff changeset
371 @item
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 7212
diff changeset
372 If you alter the compiled file (such as by compiling a new version),
55733
8b5d63bbe285 Minor cleanups.
Richard M. Stallman <rms@gnu.org>
parents: 54021
diff changeset
373 then trying to load any function not already loaded will usually yield
8b5d63bbe285 Minor cleanups.
Richard M. Stallman <rms@gnu.org>
parents: 54021
diff changeset
374 nonsense results.
12067
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 7212
diff changeset
375 @end itemize
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 7212
diff changeset
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
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 7212
diff changeset
381
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 7212
diff changeset
382 The byte compiler uses the dynamic function loading feature if the
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 7212
diff changeset
383 variable @code{byte-compile-dynamic} is non-@code{nil} at compilation
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 7212
diff changeset
384 time. Do not set this variable globally, since dynamic loading is
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 7212
diff changeset
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
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 7212
diff changeset
388
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 7212
diff changeset
389 @example
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 7212
diff changeset
390 -*-byte-compile-dynamic: t;-*-
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 7212
diff changeset
391 @end example
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 7212
diff changeset
392
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 7212
diff changeset
393 @defvar byte-compile-dynamic
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 7212
diff changeset
394 If this is non-@code{nil}, the byte compiler generates compiled files
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 7212
diff changeset
395 that are set up for dynamic function loading.
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 7212
diff changeset
396 @end defvar
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 7212
diff changeset
397
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 7212
diff changeset
398 @defun fetch-bytecode function
55733
8b5d63bbe285 Minor cleanups.
Richard M. Stallman <rms@gnu.org>
parents: 54021
diff changeset
399 If @var{function} is a byte-code function object, this immediately
8b5d63bbe285 Minor cleanups.
Richard M. Stallman <rms@gnu.org>
parents: 54021
diff changeset
400 finishes loading the byte code of @var{function} from its
8b5d63bbe285 Minor cleanups.
Richard M. Stallman <rms@gnu.org>
parents: 54021
diff changeset
401 byte-compiled file, if it is not fully loaded already. Otherwise,
8b5d63bbe285 Minor cleanups.
Richard M. Stallman <rms@gnu.org>
parents: 54021
diff changeset
402 it does nothing. It always returns @var{function}.
12067
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 7212
diff changeset
403 @end defun
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 7212
diff changeset
404
5945
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
405 @node Eval During Compile
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
406 @section Evaluation During Compilation
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
407
12067
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 7212
diff changeset
408 These features permit you to write code to be evaluated during
5945
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
409 compilation of a program.
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
410
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
411 @defspec eval-and-compile body
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
412 This form marks @var{body} to be evaluated both when you compile the
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
413 containing code and when you run it (whether compiled or not).
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
414
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
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
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
418 @end defspec
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
419
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
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
2f1305fcecf6 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents: 6452
diff changeset
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
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
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
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
431 @end defspec
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
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
8b5d63bbe285 Minor cleanups.
Richard M. Stallman <rms@gnu.org>
parents: 54021
diff changeset
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
8b5d63bbe285 Minor cleanups.
Richard M. Stallman <rms@gnu.org>
parents: 54021
diff changeset
477 @c This is implemented with a defun, but conceptually it is
8b5d63bbe285 Minor cleanups.
Richard M. Stallman <rms@gnu.org>
parents: 54021
diff changeset
478 @c a special form.
8b5d63bbe285 Minor cleanups.
Richard M. Stallman <rms@gnu.org>
parents: 54021
diff changeset
479
8b5d63bbe285 Minor cleanups.
Richard M. Stallman <rms@gnu.org>
parents: 54021
diff changeset
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
8b5d63bbe285 Minor cleanups.
Richard M. Stallman <rms@gnu.org>
parents: 54021
diff changeset
487 @end defspec
52139
6a00e88ede75 (Compiler Errors): Explain with-no-warnings
Richard M. Stallman <rms@gnu.org>
parents: 51919
diff changeset
488
5945
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
489 @node Byte-Code Objects
12098
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
490 @section Byte-Code Function Objects
5945
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
491 @cindex compiled function
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
492 @cindex byte-code function
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
493
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
494 Byte-compiled functions have a special data type: they are
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
495 @dfn{byte-code function objects}.
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
496
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
497 Internally, a byte-code function object is much like a vector;
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
498 however, the evaluator handles this data type specially when it appears
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
499 as a function to be called. The printed representation for a byte-code
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
500 function object is like that for a vector, with an additional @samp{#}
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
501 before the opening @samp{[}.
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
502
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
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
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
505 They are:
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
506
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
507 @table @var
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
508 @item arglist
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
509 The list of argument symbols.
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
510
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
511 @item byte-code
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
512 The string containing the byte-code instructions.
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
513
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
514 @item constants
7212
2f1305fcecf6 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents: 6452
diff changeset
515 The vector of Lisp objects referenced by the byte code. These include
2f1305fcecf6 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents: 6452
diff changeset
516 symbols used as function names and variable names.
5945
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
517
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
518 @item stacksize
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
519 The maximum stack size this function needs.
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
520
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
521 @item docstring
12098
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
522 The documentation string (if any); otherwise, @code{nil}. The value may
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
523 be a number or a list, in case the documentation string is stored in a
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
524 file. Use the function @code{documentation} to get the real
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
525 documentation string (@pxref{Accessing Documentation}).
5945
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
526
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
527 @item interactive
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
528 The interactive spec (if any). This can be a string or a Lisp
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
529 expression. It is @code{nil} for a function that isn't interactive.
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
530 @end table
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
531
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
532 Here's an example of a byte-code function object, in printed
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
533 representation. It is the definition of the command
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
534 @code{backward-sexp}.
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
535
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
536 @example
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
537 #[(&optional arg)
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
538 "^H\204^F^@@\301^P\302^H[!\207"
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
539 [arg 1 forward-sexp]
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
540 2
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
541 254435
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
542 "p"]
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
543 @end example
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
544
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
545 The primitive way to create a byte-code object is with
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
546 @code{make-byte-code}:
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
547
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
548 @defun make-byte-code &rest elements
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
549 This function constructs and returns a byte-code function object
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
550 with @var{elements} as its elements.
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
551 @end defun
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
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
2f1305fcecf6 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents: 6452
diff changeset
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
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
557
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
558 You can access the elements of a byte-code object using @code{aref};
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
559 you can also use @code{vconcat} to create a vector with the same
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
560 elements.
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
561
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
562 @node Disassembly
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
563 @section Disassembled Byte-Code
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
564 @cindex disassembled byte-code
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
565
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
566 People do not write byte-code; that job is left to the byte compiler.
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
567 But we provide a disassembler to satisfy a cat-like curiosity. The
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
568 disassembler converts the byte-compiled code into humanly readable
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
569 form.
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
570
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
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
2f1305fcecf6 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents: 6452
diff changeset
573 in calculations whose results are themselves pushed back on the stack.
2f1305fcecf6 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents: 6452
diff changeset
574 When a byte-code function returns, it pops a value off the stack and
2f1305fcecf6 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents: 6452
diff changeset
575 returns it as the value of the function.
5945
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
576
7212
2f1305fcecf6 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents: 6452
diff changeset
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
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
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
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
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
8b5d63bbe285 Minor cleanups.
Richard M. Stallman <rms@gnu.org>
parents: 54021
diff changeset
590 or a byte-code object. If it is a lambda expression, @code{disassemble}
8b5d63bbe285 Minor cleanups.
Richard M. Stallman <rms@gnu.org>
parents: 54021
diff changeset
591 compiles it and disassembles the resulting compiled code.
5945
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
592 @end deffn
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
593
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
594 Here are two examples of using the @code{disassemble} function. We
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
595 have added explanatory comments to help you relate the byte-code to the
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
596 Lisp source; these do not appear in the output of @code{disassemble}.
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
597 These examples show unoptimized byte-code. Nowadays byte-code is
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
598 usually optimized, but we did not want to rewrite these examples, since
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
599 they still serve their purpose.
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
600
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
601 @example
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
602 @group
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
603 (defun factorial (integer)
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
604 "Compute factorial of an integer."
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
605 (if (= 1 integer) 1
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
606 (* integer (factorial (1- integer)))))
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
607 @result{} factorial
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
608 @end group
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
609
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
610 @group
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
611 (factorial 4)
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
612 @result{} 24
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
613 @end group
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
614
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
615 @group
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
616 (disassemble 'factorial)
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
617 @print{} byte-code for factorial:
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
618 doc: Compute factorial of an integer.
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
619 args: (integer)
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
620 @end group
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
621
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
622 @group
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
623 0 constant 1 ; @r{Push 1 onto stack.}
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
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
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
626 ; @r{from the environment}
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
627 ; @r{and push the value}
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
628 ; @r{onto the stack.}
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
629 @end group
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
630
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
631 @group
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
632 2 eqlsign ; @r{Pop top two values off stack,}
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
633 ; @r{compare them,}
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
634 ; @r{and push result onto stack.}
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
635 @end group
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
636
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
637 @group
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
638 3 goto-if-nil 10 ; @r{Pop and test top of stack;}
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
639 ; @r{if @code{nil}, go to 10,}
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
640 ; @r{else continue.}
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
641 @end group
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
642
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
643 @group
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
644 6 constant 1 ; @r{Push 1 onto top of stack.}
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
645
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
646 7 goto 17 ; @r{Go to 17 (in this case, 1 will be}
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
647 ; @r{returned by the function).}
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
648 @end group
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
649
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
650 @group
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
651 10 constant * ; @r{Push symbol @code{*} onto stack.}
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
652
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
653 11 varref integer ; @r{Push value of @code{integer} onto stack.}
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
654 @end group
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
655
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
656 @group
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
657 12 constant factorial ; @r{Push @code{factorial} onto stack.}
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
658
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
659 13 varref integer ; @r{Push value of @code{integer} onto stack.}
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
660
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
661 14 sub1 ; @r{Pop @code{integer}, decrement value,}
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
662 ; @r{push new value onto stack.}
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
663 @end group
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
664
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
665 @group
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
666 ; @r{Stack now contains:}
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
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
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
669 ; @minus{} @r{value of @code{integer}}
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
670 ; @minus{} @r{@code{*}}
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
671 @end group
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
672
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
673 @group
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
674 15 call 1 ; @r{Call function @code{factorial} using}
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
675 ; @r{the first (i.e., the top) element}
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
676 ; @r{of the stack as the argument;}
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
677 ; @r{push returned value onto stack.}
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
678 @end group
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
679
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
680 @group
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
681 ; @r{Stack now contains:}
7212
2f1305fcecf6 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents: 6452
diff changeset
682 ; @minus{} @r{result of recursive}
5945
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
683 ; @r{call to @code{factorial}}
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
684 ; @minus{} @r{value of @code{integer}}
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
685 ; @minus{} @r{@code{*}}
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
686 @end group
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
687
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
688 @group
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
689 16 call 2 ; @r{Using the first two}
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
690 ; @r{(i.e., the top two)}
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
691 ; @r{elements of the stack}
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
692 ; @r{as arguments,}
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
693 ; @r{call the function @code{*},}
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
694 ; @r{pushing the result onto the stack.}
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
695 @end group
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
696
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
697 @group
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
698 17 return ; @r{Return the top element}
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
699 ; @r{of the stack.}
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
700 @result{} nil
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
701 @end group
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
702 @end example
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
703
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
704 The @code{silly-loop} function is somewhat more complex:
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
705
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
706 @example
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
707 @group
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
708 (defun silly-loop (n)
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
709 "Return time before and after N iterations of a loop."
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
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
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
712 0))
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
713 (list t1 (current-time-string))))
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
714 @result{} silly-loop
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
715 @end group
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
716
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
717 @group
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
718 (disassemble 'silly-loop)
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
719 @print{} byte-code for silly-loop:
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
720 doc: Return time before and after N iterations of a loop.
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
721 args: (n)
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
722
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
723 0 constant current-time-string ; @r{Push}
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
724 ; @r{@code{current-time-string}}
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
725 ; @r{onto top of stack.}
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
726 @end group
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
727
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
728 @group
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
729 1 call 0 ; @r{Call @code{current-time-string}}
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
730 ; @r{ with no argument,}
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
731 ; @r{ pushing result onto stack.}
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
732 @end group
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
733
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
734 @group
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
735 2 varbind t1 ; @r{Pop stack and bind @code{t1}}
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
736 ; @r{to popped value.}
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
737 @end group
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
738
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
739 @group
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
740 3 varref n ; @r{Get value of @code{n} from}
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
741 ; @r{the environment and push}
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
742 ; @r{the value onto the stack.}
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
743 @end group
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
744
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
745 @group
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
746 4 sub1 ; @r{Subtract 1 from top of stack.}
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
747 @end group
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
748
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
749 @group
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
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
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
752 ; @r{the stack and push the}
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
753 ; @r{copy onto the stack.}
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
754 @end group
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
755
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
756 @group
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
757 6 varset n ; @r{Pop the top of the stack,}
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
758 ; @r{and bind @code{n} to the value.}
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
759
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
760 ; @r{In effect, the sequence @code{dup varset}}
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
761 ; @r{copies the top of the stack}
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
762 ; @r{into the value of @code{n}}
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
763 ; @r{without popping it.}
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
764 @end group
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
765
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
766 @group
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
767 7 constant 0 ; @r{Push 0 onto stack.}
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
768 @end group
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
769
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
770 @group
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
771 8 gtr ; @r{Pop top two values off stack,}
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
772 ; @r{test if @var{n} is greater than 0}
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
773 ; @r{and push result onto stack.}
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
774 @end group
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
775
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
776 @group
7212
2f1305fcecf6 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents: 6452
diff changeset
777 9 goto-if-nil-else-pop 17 ; @r{Goto 17 if @code{n} <= 0}
2f1305fcecf6 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents: 6452
diff changeset
778 ; @r{(this exits the while loop).}
5945
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
779 ; @r{else pop top of stack}
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
780 ; @r{and continue}
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
781 @end group
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
782
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
783 @group
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
784 12 constant nil ; @r{Push @code{nil} onto stack}
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
785 ; @r{(this is the body of the loop).}
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
786 @end group
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
787
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
788 @group
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
789 13 discard ; @r{Discard result of the body}
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
790 ; @r{of the loop (a while loop}
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
791 ; @r{is always evaluated for}
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
792 ; @r{its side effects).}
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
793 @end group
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
794
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
795 @group
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
796 14 goto 3 ; @r{Jump back to beginning}
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
797 ; @r{of while loop.}
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
798 @end group
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
799
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
800 @group
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
801 17 discard ; @r{Discard result of while loop}
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
802 ; @r{by popping top of stack.}
7212
2f1305fcecf6 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents: 6452
diff changeset
803 ; @r{This result is the value @code{nil} that}
2f1305fcecf6 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents: 6452
diff changeset
804 ; @r{was not popped by the goto at 9.}
5945
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
805 @end group
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
806
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
807 @group
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
808 18 varref t1 ; @r{Push value of @code{t1} onto stack.}
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
809 @end group
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
810
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
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
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
813 ; @r{@code{current-time-string}}
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
814 ; @r{onto top of stack.}
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
815 @end group
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
816
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
817 @group
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
818 20 call 0 ; @r{Call @code{current-time-string} again.}
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
819 @end group
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
820
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
821 @group
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
822 21 list2 ; @r{Pop top two elements off stack,}
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
823 ; @r{create a list of them,}
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
824 ; @r{and push list onto stack.}
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
825 @end group
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
826
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
827 @group
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
828 22 unbind 1 ; @r{Unbind @code{t1} in local environment.}
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
829
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
830 23 return ; @r{Return value of the top of stack.}
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
831
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
832 @result{} nil
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
833 @end group
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
834 @end example
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
835
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
836
52401
695cf19ef79e Add arch taglines
Miles Bader <miles@gnu.org>
parents: 52155
diff changeset
837 @ignore
695cf19ef79e Add arch taglines
Miles Bader <miles@gnu.org>
parents: 52155
diff changeset
838 arch-tag: f78e3050-2f0a-4dee-be27-d9979a0a2289
695cf19ef79e Add arch taglines
Miles Bader <miles@gnu.org>
parents: 52155
diff changeset
839 @end ignore