annotate lispref/compile.texi @ 46915:5bae22b90bf5

Fix typo.
author Richard M. Stallman <rms@gnu.org>
date Thu, 15 Aug 2002 20:33:01 +0000
parents 05a836654c88
children 23a1cea22d13
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.
6452
8c7032348e93 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 5945
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
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
42 @xref{Compilation Errors}, for how to investigate errors occurring in
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
43 byte compilation.
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
44
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
45 @menu
6452
8c7032348e93 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 5945
diff changeset
46 * Speed of Byte-Code:: An example of speedup from byte compilation.
5945
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
47 * Compilation Functions:: Byte compilation functions.
12067
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 7212
diff changeset
48 * Docs and Compilation:: Dynamic loading of documentation strings.
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 7212
diff changeset
49 * Dynamic Loading:: Dynamic loading of individual functions.
5945
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
50 * Eval During Compile:: Code to be evaluated when you compile.
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
51 * Byte-Code Objects:: The data type used for byte-compiled functions.
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
52 * Disassembly:: Disassembling byte-code; how to read byte-code.
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
53 @end menu
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
54
6452
8c7032348e93 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 5945
diff changeset
55 @node Speed of Byte-Code
8c7032348e93 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 5945
diff changeset
56 @section Performance of Byte-Compiled Code
8c7032348e93 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 5945
diff changeset
57
8c7032348e93 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 5945
diff changeset
58 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
59 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
60 Here is an example:
8c7032348e93 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 5945
diff changeset
61
8c7032348e93 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 5945
diff changeset
62 @example
8c7032348e93 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 5945
diff changeset
63 @group
8c7032348e93 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 5945
diff changeset
64 (defun silly-loop (n)
8c7032348e93 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 5945
diff changeset
65 "Return time before and after N iterations of a loop."
8c7032348e93 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 5945
diff changeset
66 (let ((t1 (current-time-string)))
8c7032348e93 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 5945
diff changeset
67 (while (> (setq n (1- n))
8c7032348e93 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 5945
diff changeset
68 0))
8c7032348e93 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 5945
diff changeset
69 (list t1 (current-time-string))))
8c7032348e93 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 5945
diff changeset
70 @result{} silly-loop
8c7032348e93 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 5945
diff changeset
71 @end group
8c7032348e93 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 5945
diff changeset
72
8c7032348e93 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 5945
diff changeset
73 @group
8c7032348e93 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 5945
diff changeset
74 (silly-loop 100000)
8c7032348e93 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 5945
diff changeset
75 @result{} ("Fri Mar 18 17:25:57 1994"
8c7032348e93 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 5945
diff changeset
76 "Fri Mar 18 17:26:28 1994") ; @r{31 seconds}
8c7032348e93 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 5945
diff changeset
77 @end group
8c7032348e93 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 5945
diff changeset
78
8c7032348e93 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 5945
diff changeset
79 @group
8c7032348e93 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 5945
diff changeset
80 (byte-compile 'silly-loop)
8c7032348e93 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 5945
diff changeset
81 @result{} @r{[Compiled code not shown]}
8c7032348e93 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 5945
diff changeset
82 @end group
8c7032348e93 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 5945
diff changeset
83
8c7032348e93 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 5945
diff changeset
84 @group
8c7032348e93 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 5945
diff changeset
85 (silly-loop 100000)
8c7032348e93 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 5945
diff changeset
86 @result{} ("Fri Mar 18 17:26:52 1994"
8c7032348e93 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 5945
diff changeset
87 "Fri Mar 18 17:26:58 1994") ; @r{6 seconds}
8c7032348e93 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 5945
diff changeset
88 @end group
8c7032348e93 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 5945
diff changeset
89 @end example
8c7032348e93 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 5945
diff changeset
90
8c7032348e93 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 5945
diff changeset
91 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
92 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
93 representative, but actual results will vary greatly.
8c7032348e93 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 5945
diff changeset
94
5945
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
95 @node Compilation Functions
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
96 @comment node-name, next, previous, up
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
97 @section The Compilation Functions
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
98 @cindex compilation functions
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
99
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
100 You can byte-compile an individual function or macro definition with
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
101 the @code{byte-compile} function. You can compile a whole file with
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
102 @code{byte-compile-file}, or several files with
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
103 @code{byte-recompile-directory} or @code{batch-byte-compile}.
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
104
16736
981e116b4ac6 Minor cleanups for overfull hboxes.
Richard M. Stallman <rms@gnu.org>
parents: 12128
diff changeset
105 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
106 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
107 program that suggest a problem but are not necessarily erroneous.
5945
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 @cindex macro compilation
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
110 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
111 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
112 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
113 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
114 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
115 definitions are one likely cause (@pxref{Problems with Macros}).
5945
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
116
6452
8c7032348e93 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 5945
diff changeset
117 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
118 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
119 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
120 are available during compilation is to require the file that defines
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
121 them (@pxref{Named Features}). To avoid loading the macro definition files
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
122 when someone @emph{runs} the compiled program, write
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
123 @code{eval-when-compile} around the @code{require} calls (@pxref{Eval
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
124 During Compile}).
5945
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
125
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
126 @defun byte-compile symbol
6452
8c7032348e93 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 5945
diff changeset
127 This function byte-compiles the function definition of @var{symbol},
5945
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
128 replacing the previous definition with the compiled one. The function
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
129 definition of @var{symbol} must be the actual code for the function;
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
130 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
131 @code{byte-compile} returns the new, compiled definition of
8c7032348e93 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 5945
diff changeset
132 @var{symbol}.
8c7032348e93 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 5945
diff changeset
133
12067
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 7212
diff changeset
134 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
135 @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
136 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
137 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
138 way to ``compile the same definition again.''
5945
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
139
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
140 @example
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
141 @group
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
142 (defun factorial (integer)
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
143 "Compute factorial of INTEGER."
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
144 (if (= 1 integer) 1
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
145 (* integer (factorial (1- integer)))))
6452
8c7032348e93 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 5945
diff changeset
146 @result{} factorial
5945
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
147 @end group
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 @group
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
150 (byte-compile 'factorial)
6452
8c7032348e93 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 5945
diff changeset
151 @result{}
5945
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
152 #[(integer)
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
153 "^H\301U\203^H^@@\301\207\302^H\303^HS!\"\207"
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
154 [integer 1 * factorial]
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
155 4 "Compute factorial of INTEGER."]
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 @end example
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
158
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
159 @noindent
6452
8c7032348e93 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 5945
diff changeset
160 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
161 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
162 operand of an instruction. The vector contains all the constants,
8c7032348e93 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 5945
diff changeset
163 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
164 certain primitives that are coded as special instructions.
5945
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
165 @end defun
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
166
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
167 @deffn Command compile-defun
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
168 This command reads the defun containing point, compiles it, and
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
169 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
170 function definition, the effect is to install a compiled version of that
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
171 function.
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
172 @end deffn
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
173
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
174 @deffn Command byte-compile-file filename
22138
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
175 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
176 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
177 @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
178 @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
179
6452
8c7032348e93 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 5945
diff changeset
180 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
181 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
182 definition is written out. Other forms are batched together, then each
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
183 batch is compiled, and written so that its compiled code will be
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
184 executed when the file is read. All comments are discarded when the
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
185 input file is read.
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
186
6452
8c7032348e93 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 5945
diff changeset
187 This command returns @code{t}. When called interactively, it prompts
5945
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
188 for the file name.
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
189
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
190 @example
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
191 @group
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
192 % ls -l push*
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
193 -rw-r--r-- 1 lewis 791 Oct 5 20:31 push.el
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
194 @end group
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
195
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
196 @group
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
197 (byte-compile-file "~/emacs/push.el")
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
198 @result{} t
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
199 @end group
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
200
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
201 @group
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
202 % ls -l push*
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
203 -rw-r--r-- 1 lewis 791 Oct 5 20:31 push.el
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
204 -rw-rw-rw- 1 lewis 638 Oct 8 20:25 push.elc
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
205 @end group
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
206 @end example
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
207 @end deffn
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
208
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
209 @deffn Command byte-recompile-directory directory flag
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
210 @cindex library compilation
6452
8c7032348e93 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 5945
diff changeset
211 This function recompiles every @samp{.el} file in @var{directory} that
5945
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
212 needs recompilation. A file needs recompilation if a @samp{.elc} file
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
213 exists but is older than the @samp{.el} file.
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
214
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
215 When a @samp{.el} file has no corresponding @samp{.elc} file, @var{flag}
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
216 says what to do. If it is @code{nil}, these files are ignored. If it
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
217 is non-@code{nil}, the user is asked whether to compile each such file.
5945
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
218
6452
8c7032348e93 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 5945
diff changeset
219 The returned value of this command is unpredictable.
5945
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
220 @end deffn
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
221
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
222 @defun batch-byte-compile
6452
8c7032348e93 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 5945
diff changeset
223 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
224 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
225 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
226 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
227 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
228 status code.
5945
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
229
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
230 @example
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
231 % emacs -batch -f batch-byte-compile *.el
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
232 @end example
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
233 @end defun
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
234
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
235 @defun byte-code code-string data-vector max-stack
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
236 @cindex byte-code interpreter
6452
8c7032348e93 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 5945
diff changeset
237 This function actually interprets byte-code. A byte-compiled function
5945
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
238 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
239 this function yourself---only the byte compiler knows how to generate
5945
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
240 valid calls to this function.
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
241
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
242 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
243 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
244 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
245 explicit call to @code{byte-code}.
5945
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
246 @end defun
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
247
12067
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 7212
diff changeset
248 @node Docs and Compilation
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 7212
diff changeset
249 @section Documentation Strings and Compilation
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 7212
diff changeset
250 @cindex dynamic loading of documentation
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 7212
diff changeset
251
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 7212
diff changeset
252 Functions and variables loaded from a byte-compiled file access their
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 7212
diff changeset
253 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
254 saves space within Emacs, and makes loading faster because the
12067
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 7212
diff changeset
255 documentation strings themselves need not be processed while loading the
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 7212
diff changeset
256 file. Actual access to the documentation strings becomes slower as a
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 7212
diff changeset
257 result, but this normally is not enough to bother users.
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 7212
diff changeset
258
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 7212
diff changeset
259 Dynamic access to documentation strings does have drawbacks:
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 7212
diff changeset
260
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 7212
diff changeset
261 @itemize @bullet
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 7212
diff changeset
262 @item
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 7212
diff changeset
263 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
264 longer access the documentation strings for the functions and variables
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 7212
diff changeset
265 in the file.
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 7212
diff changeset
266
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 7212
diff changeset
267 @item
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 7212
diff changeset
268 If you alter the compiled file (such as by compiling a new version),
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 7212
diff changeset
269 then further access to documentation strings in this file will give
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 7212
diff changeset
270 nonsense results.
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 7212
diff changeset
271 @end itemize
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 7212
diff changeset
272
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 7212
diff changeset
273 If your site installs Emacs following the usual procedures, these
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 7212
diff changeset
274 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
275 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
276 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
277 expected to be.
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 7212
diff changeset
278
12124
437eb190e7a7 updated for 19.29.
Melissa Weisshaus <melissa@gnu.org>
parents: 12098
diff changeset
279 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
280 directory where you built it, you will experience this problem
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 7212
diff changeset
281 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
282 can cure the problem by reloading the file after recompiling it.
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 7212
diff changeset
283
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
284 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
285 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
286 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
287 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
288 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
289 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
290 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
291 file's first line:
12067
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 @example
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 7212
diff changeset
294 -*-byte-compile-dynamic-docstrings: nil;-*-
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 7212
diff changeset
295 @end example
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 7212
diff changeset
296
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 7212
diff changeset
297 @defvar byte-compile-dynamic-docstrings
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 7212
diff changeset
298 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
299 that are set up for dynamic loading of documentation strings.
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 7212
diff changeset
300 @end defvar
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 7212
diff changeset
301
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 7212
diff changeset
302 @cindex @samp{#@@@var{count}}
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 7212
diff changeset
303 @cindex @samp{#$}
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 7212
diff changeset
304 The dynamic documentation string feature writes compiled files that
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 7212
diff changeset
305 use a special Lisp reader construct, @samp{#@@@var{count}}. This
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 7212
diff changeset
306 construct skips the next @var{count} characters. It also uses the
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 7212
diff changeset
307 @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
308 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
309 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
310 file.
12067
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 7212
diff changeset
311
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 7212
diff changeset
312 @node Dynamic Loading
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 7212
diff changeset
313 @section Dynamic Loading of Individual Functions
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 7212
diff changeset
314
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 7212
diff changeset
315 @cindex dynamic loading of functions
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 7212
diff changeset
316 @cindex lazy loading
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 7212
diff changeset
317 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
318 function loading} feature (also known as @dfn{lazy loading}). With
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 7212
diff changeset
319 dynamic function loading, loading the file doesn't fully read the
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 7212
diff changeset
320 function definitions in the file. Instead, each function definition
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 7212
diff changeset
321 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
322 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
323 replace the place-holder.
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 The advantage of dynamic function loading is that loading the file
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 7212
diff changeset
326 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
327 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
328 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
329 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
330 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
331
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 7212
diff changeset
332 The dynamic loading feature has certain disadvantages:
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 @itemize @bullet
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 7212
diff changeset
335 @item
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 7212
diff changeset
336 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
337 longer load the remaining function definitions not already loaded.
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 7212
diff changeset
338
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 7212
diff changeset
339 @item
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 7212
diff changeset
340 If you alter the compiled file (such as by compiling a new version),
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
341 then trying to load any function not already loaded will yield nonsense
12067
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 7212
diff changeset
342 results.
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 7212
diff changeset
343 @end itemize
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 7212
diff changeset
344
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
345 These problems will never happen in normal circumstances with
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
346 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
347 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
348 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
349
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 7212
diff changeset
350 The byte compiler uses the dynamic function loading feature if the
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 7212
diff changeset
351 variable @code{byte-compile-dynamic} is non-@code{nil} at compilation
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 7212
diff changeset
352 time. Do not set this variable globally, since dynamic loading is
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 7212
diff changeset
353 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
354 specific source files with file-local variable bindings. For example,
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
355 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
356
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 7212
diff changeset
357 @example
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 7212
diff changeset
358 -*-byte-compile-dynamic: t;-*-
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 7212
diff changeset
359 @end example
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 7212
diff changeset
360
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 7212
diff changeset
361 @defvar byte-compile-dynamic
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 7212
diff changeset
362 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
363 that are set up for dynamic function loading.
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 7212
diff changeset
364 @end defvar
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 @defun fetch-bytecode function
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 7212
diff changeset
367 This immediately finishes loading the definition of @var{function} from
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 7212
diff changeset
368 its byte-compiled file, if it is not fully loaded already. The argument
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 7212
diff changeset
369 @var{function} may be a byte-code function object or a function name.
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 7212
diff changeset
370 @end defun
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 7212
diff changeset
371
5945
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
372 @node Eval During Compile
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
373 @section Evaluation During Compilation
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
374
12067
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 7212
diff changeset
375 These features permit you to write code to be evaluated during
5945
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
376 compilation of a program.
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
377
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
378 @defspec eval-and-compile body
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
379 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
380 containing code and when you run it (whether compiled or not).
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
381
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
382 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
383 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
384 preferable when @var{body} is large.
5945
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
385 @end defspec
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
386
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
387 @defspec eval-when-compile body
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 16736
diff changeset
388 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
389 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
390 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
391 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
392 evaluated normally.
5945
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
393
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
394 @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
395 Lisp idiom @code{(eval-when (compile eval) @dots{})}. Elsewhere, the
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
396 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
397 to what @code{eval-when-compile} does.
5945
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
398 @end defspec
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
399
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
400 @node Byte-Code Objects
12098
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
401 @section Byte-Code Function Objects
5945
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
402 @cindex compiled function
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
403 @cindex byte-code function
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
404
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
405 Byte-compiled functions have a special data type: they are
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
406 @dfn{byte-code function objects}.
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
407
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
408 Internally, a byte-code function object is much like a vector;
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
409 however, the evaluator handles this data type specially when it appears
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
410 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
411 function object is like that for a vector, with an additional @samp{#}
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
412 before the opening @samp{[}.
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
413
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
414 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
415 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
416 They are:
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
417
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
418 @table @var
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
419 @item arglist
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
420 The list of argument symbols.
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
421
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
422 @item byte-code
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
423 The string containing the byte-code instructions.
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
424
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
425 @item constants
7212
2f1305fcecf6 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents: 6452
diff changeset
426 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
427 symbols used as function names and variable names.
5945
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
428
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
429 @item stacksize
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
430 The maximum stack size this function needs.
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
431
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
432 @item docstring
12098
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
433 The documentation string (if any); otherwise, @code{nil}. The value may
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
434 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
435 file. Use the function @code{documentation} to get the real
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
436 documentation string (@pxref{Accessing Documentation}).
5945
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
437
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
438 @item interactive
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
439 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
440 expression. It is @code{nil} for a function that isn't interactive.
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
441 @end table
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
442
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
443 Here's an example of a byte-code function object, in printed
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
444 representation. It is the definition of the command
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
445 @code{backward-sexp}.
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
446
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
447 @example
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
448 #[(&optional arg)
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
449 "^H\204^F^@@\301^P\302^H[!\207"
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
450 [arg 1 forward-sexp]
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
451 2
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
452 254435
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
453 "p"]
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
454 @end example
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
455
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
456 The primitive way to create a byte-code object is with
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
457 @code{make-byte-code}:
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
458
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
459 @defun make-byte-code &rest elements
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
460 This function constructs and returns a byte-code function object
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
461 with @var{elements} as its elements.
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
462 @end defun
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
463
6452
8c7032348e93 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 5945
diff changeset
464 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
465 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
466 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
467 create these objects; it makes the elements consistent (we hope).
5945
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
468
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
469 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
470 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
471 elements.
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
472
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
473 @node Disassembly
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
474 @section Disassembled Byte-Code
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
475 @cindex disassembled byte-code
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
476
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
477 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
478 But we provide a disassembler to satisfy a cat-like curiosity. The
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
479 disassembler converts the byte-compiled code into humanly readable
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
480 form.
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
481
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
482 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
483 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
484 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
485 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
486 returns it as the value of the function.
5945
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
487
7212
2f1305fcecf6 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents: 6452
diff changeset
488 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
489 ordinary Lisp variables, by transferring values between variables and
8c7032348e93 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 5945
diff changeset
490 the stack.
5945
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
491
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
492 @deffn Command disassemble object &optional stream
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
493 This function prints the disassembled code for @var{object}. If
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
494 @var{stream} is supplied, then output goes there. Otherwise, the
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
495 disassembled code is printed to the stream @code{standard-output}. The
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
496 argument @var{object} can be a function name or a lambda expression.
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
497
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
498 As a special exception, if this function is used interactively,
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
499 it outputs to a buffer named @samp{*Disassemble*}.
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
500 @end deffn
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
501
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
502 Here are two examples of using the @code{disassemble} function. We
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
503 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
504 Lisp source; these do not appear in the output of @code{disassemble}.
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
505 These examples show unoptimized byte-code. Nowadays byte-code is
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
506 usually optimized, but we did not want to rewrite these examples, since
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
507 they still serve their purpose.
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
508
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
509 @example
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
510 @group
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
511 (defun factorial (integer)
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
512 "Compute factorial of an integer."
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
513 (if (= 1 integer) 1
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
514 (* integer (factorial (1- integer)))))
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
515 @result{} factorial
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
516 @end group
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 @group
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
519 (factorial 4)
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
520 @result{} 24
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
521 @end group
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
522
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
523 @group
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
524 (disassemble 'factorial)
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
525 @print{} byte-code for factorial:
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
526 doc: Compute factorial of an integer.
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
527 args: (integer)
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
528 @end group
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
529
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
530 @group
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
531 0 constant 1 ; @r{Push 1 onto stack.}
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
532
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
533 1 varref integer ; @r{Get value of @code{integer}}
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
534 ; @r{from the environment}
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
535 ; @r{and push the value}
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
536 ; @r{onto the stack.}
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
537 @end group
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
538
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
539 @group
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
540 2 eqlsign ; @r{Pop top two values off stack,}
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
541 ; @r{compare them,}
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
542 ; @r{and push result onto stack.}
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
543 @end group
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 @group
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
546 3 goto-if-nil 10 ; @r{Pop and test top of stack;}
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
547 ; @r{if @code{nil}, go to 10,}
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
548 ; @r{else continue.}
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
549 @end group
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
550
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
551 @group
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
552 6 constant 1 ; @r{Push 1 onto top of stack.}
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
553
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
554 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
555 ; @r{returned by the function).}
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
556 @end group
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 @group
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
559 10 constant * ; @r{Push symbol @code{*} onto stack.}
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
560
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
561 11 varref integer ; @r{Push value of @code{integer} onto stack.}
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
562 @end group
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
563
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
564 @group
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
565 12 constant factorial ; @r{Push @code{factorial} onto stack.}
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
566
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
567 13 varref integer ; @r{Push value of @code{integer} onto stack.}
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
568
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
569 14 sub1 ; @r{Pop @code{integer}, decrement value,}
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
570 ; @r{push new value onto stack.}
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
571 @end group
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
572
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
573 @group
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
574 ; @r{Stack now contains:}
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
575 ; @minus{} @r{decremented value of @code{integer}}
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
576 ; @minus{} @r{@code{factorial}}
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
577 ; @minus{} @r{value of @code{integer}}
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
578 ; @minus{} @r{@code{*}}
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
579 @end group
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
580
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
581 @group
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
582 15 call 1 ; @r{Call function @code{factorial} using}
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
583 ; @r{the first (i.e., the top) element}
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
584 ; @r{of the stack as the argument;}
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
585 ; @r{push returned value onto stack.}
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
586 @end group
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
587
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
588 @group
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
589 ; @r{Stack now contains:}
7212
2f1305fcecf6 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents: 6452
diff changeset
590 ; @minus{} @r{result of recursive}
5945
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
591 ; @r{call to @code{factorial}}
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
592 ; @minus{} @r{value of @code{integer}}
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
593 ; @minus{} @r{@code{*}}
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
594 @end group
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
595
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
596 @group
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
597 16 call 2 ; @r{Using the first two}
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
598 ; @r{(i.e., the top two)}
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
599 ; @r{elements of the stack}
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
600 ; @r{as arguments,}
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
601 ; @r{call the function @code{*},}
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
602 ; @r{pushing the result onto the stack.}
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
603 @end group
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
604
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
605 @group
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
606 17 return ; @r{Return the top element}
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
607 ; @r{of the stack.}
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
608 @result{} nil
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
609 @end group
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
610 @end example
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
611
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
612 The @code{silly-loop} function is somewhat more complex:
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
613
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
614 @example
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 (defun silly-loop (n)
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
617 "Return time before and after N iterations of a loop."
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
618 (let ((t1 (current-time-string)))
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
619 (while (> (setq n (1- n))
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
620 0))
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
621 (list t1 (current-time-string))))
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
622 @result{} silly-loop
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
623 @end group
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
624
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
625 @group
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
626 (disassemble 'silly-loop)
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
627 @print{} byte-code for silly-loop:
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
628 doc: Return time before and after N iterations of a loop.
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
629 args: (n)
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 0 constant current-time-string ; @r{Push}
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
632 ; @r{@code{current-time-string}}
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
633 ; @r{onto top of stack.}
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
634 @end group
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
635
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
636 @group
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
637 1 call 0 ; @r{Call @code{current-time-string}}
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
638 ; @r{ with no argument,}
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
639 ; @r{ pushing result onto stack.}
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
640 @end group
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
641
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
642 @group
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
643 2 varbind t1 ; @r{Pop stack and bind @code{t1}}
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
644 ; @r{to popped value.}
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
645 @end group
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
646
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
647 @group
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
648 3 varref n ; @r{Get value of @code{n} from}
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
649 ; @r{the environment and push}
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
650 ; @r{the value onto the stack.}
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
651 @end group
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 @group
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
654 4 sub1 ; @r{Subtract 1 from top of stack.}
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
655 @end group
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
656
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
657 @group
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
658 5 dup ; @r{Duplicate the top of the stack;}
6452
8c7032348e93 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 5945
diff changeset
659 ; @r{i.e., copy the top of}
5945
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
660 ; @r{the stack and push the}
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
661 ; @r{copy onto the stack.}
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
662 @end group
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
663
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
664 @group
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
665 6 varset n ; @r{Pop the top of the stack,}
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
666 ; @r{and bind @code{n} to the value.}
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
667
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
668 ; @r{In effect, the sequence @code{dup varset}}
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
669 ; @r{copies the top of the stack}
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
670 ; @r{into the value of @code{n}}
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
671 ; @r{without popping it.}
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
672 @end group
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
673
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
674 @group
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
675 7 constant 0 ; @r{Push 0 onto stack.}
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
676 @end group
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
677
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
678 @group
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
679 8 gtr ; @r{Pop top two values off stack,}
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
680 ; @r{test if @var{n} is greater than 0}
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
681 ; @r{and push result onto stack.}
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
682 @end group
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
683
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
684 @group
7212
2f1305fcecf6 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents: 6452
diff changeset
685 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
686 ; @r{(this exits the while loop).}
5945
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
687 ; @r{else pop top of stack}
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
688 ; @r{and continue}
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
689 @end group
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
690
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
691 @group
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
692 12 constant nil ; @r{Push @code{nil} onto stack}
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
693 ; @r{(this is the body of the loop).}
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
694 @end group
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
695
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
696 @group
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
697 13 discard ; @r{Discard result of the body}
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
698 ; @r{of the loop (a while loop}
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
699 ; @r{is always evaluated for}
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
700 ; @r{its side effects).}
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
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
703 @group
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
704 14 goto 3 ; @r{Jump back to beginning}
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
705 ; @r{of while loop.}
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
706 @end group
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
707
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
708 @group
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
709 17 discard ; @r{Discard result of while loop}
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
710 ; @r{by popping top of stack.}
7212
2f1305fcecf6 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents: 6452
diff changeset
711 ; @r{This result is the value @code{nil} that}
2f1305fcecf6 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents: 6452
diff changeset
712 ; @r{was not popped by the goto at 9.}
5945
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
713 @end group
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
714
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
715 @group
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
716 18 varref t1 ; @r{Push value of @code{t1} onto stack.}
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
717 @end group
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
718
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
719 @group
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
720 19 constant current-time-string ; @r{Push}
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
721 ; @r{@code{current-time-string}}
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
722 ; @r{onto top of stack.}
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
723 @end group
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
724
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
725 @group
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
726 20 call 0 ; @r{Call @code{current-time-string} again.}
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
727 @end group
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
728
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
729 @group
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
730 21 list2 ; @r{Pop top two elements off stack,}
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
731 ; @r{create a list of them,}
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
732 ; @r{and push list onto stack.}
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
733 @end group
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
734
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
735 @group
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
736 22 unbind 1 ; @r{Unbind @code{t1} in local environment.}
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
737
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
738 23 return ; @r{Return value of the top of stack.}
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
739
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
740 @result{} nil
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
741 @end group
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
742 @end example
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
743
e449bfa3caae Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
744