Commit | Line | Data |
---|---|---|
fd5285f3 RS |
1 | ;;; bytecomp.el --- compilation of Lisp code into byte code. |
2 | ||
b578f267 | 3 | ;; Copyright (C) 1985, 1986, 1987, 1992, 1994 Free Software Foundation, Inc. |
3a801d0c | 4 | |
fd5285f3 RS |
5 | ;; Author: Jamie Zawinski <jwz@lucid.com> |
6 | ;; Hallvard Furuseth <hbf@ulrik.uio.no> | |
fd5285f3 | 7 | ;; Keywords: internal |
1c393159 | 8 | |
52799cb8 | 9 | ;; Subsequently modified by RMS. |
1c393159 | 10 | |
e27c3564 | 11 | ;;; This version incorporates changes up to version 2.10 of the |
9e2b097b | 12 | ;;; Zawinski-Furuseth compiler. |
b077f045 | 13 | (defconst byte-compile-version "$Revision: 2.32 $") |
1c393159 JB |
14 | |
15 | ;; This file is part of GNU Emacs. | |
16 | ||
17 | ;; GNU Emacs is free software; you can redistribute it and/or modify | |
18 | ;; it under the terms of the GNU General Public License as published by | |
fd5285f3 | 19 | ;; the Free Software Foundation; either version 2, or (at your option) |
1c393159 JB |
20 | ;; any later version. |
21 | ||
22 | ;; GNU Emacs is distributed in the hope that it will be useful, | |
23 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of | |
24 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
25 | ;; GNU General Public License for more details. | |
26 | ||
27 | ;; You should have received a copy of the GNU General Public License | |
b578f267 EN |
28 | ;; along with GNU Emacs; see the file COPYING. If not, write to the |
29 | ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330, | |
30 | ;; Boston, MA 02111-1307, USA. | |
1c393159 | 31 | |
e41b2db1 ER |
32 | ;;; Commentary: |
33 | ||
34 | ;; The Emacs Lisp byte compiler. This crunches lisp source into a sort | |
35 | ;; of p-code which takes up less space and can be interpreted faster. | |
36 | ;; The user entry points are byte-compile-file and byte-recompile-directory. | |
37 | ||
fd5285f3 RS |
38 | ;;; Code: |
39 | ||
b578f267 EN |
40 | ;; ======================================================================== |
41 | ;; Entry points: | |
42 | ;; byte-recompile-directory, byte-compile-file, | |
43 | ;; batch-byte-compile, batch-byte-recompile-directory, | |
44 | ;; byte-compile, compile-defun, | |
45 | ;; display-call-tree | |
46 | ;; (byte-compile-buffer and byte-compile-and-load-file were turned off | |
47 | ;; because they are not terribly useful and get in the way of completion.) | |
48 | ||
49 | ;; This version of the byte compiler has the following improvements: | |
50 | ;; + optimization of compiled code: | |
51 | ;; - removal of unreachable code; | |
52 | ;; - removal of calls to side-effectless functions whose return-value | |
53 | ;; is unused; | |
54 | ;; - compile-time evaluation of safe constant forms, such as (consp nil) | |
55 | ;; and (ash 1 6); | |
56 | ;; - open-coding of literal lambdas; | |
57 | ;; - peephole optimization of emitted code; | |
58 | ;; - trivial functions are left uncompiled for speed. | |
59 | ;; + support for inline functions; | |
60 | ;; + compile-time evaluation of arbitrary expressions; | |
61 | ;; + compile-time warning messages for: | |
62 | ;; - functions being redefined with incompatible arglists; | |
63 | ;; - functions being redefined as macros, or vice-versa; | |
64 | ;; - functions or macros defined multiple times in the same file; | |
65 | ;; - functions being called with the incorrect number of arguments; | |
66 | ;; - functions being called which are not defined globally, in the | |
67 | ;; file, or as autoloads; | |
68 | ;; - assignment and reference of undeclared free variables; | |
69 | ;; - various syntax errors; | |
70 | ;; + correct compilation of nested defuns, defmacros, defvars and defsubsts; | |
71 | ;; + correct compilation of top-level uses of macros; | |
72 | ;; + the ability to generate a histogram of functions called. | |
73 | ||
74 | ;; User customization variables: | |
75 | ;; | |
76 | ;; byte-compile-verbose Whether to report the function currently being | |
77 | ;; compiled in the minibuffer; | |
78 | ;; byte-optimize Whether to do optimizations; this may be | |
79 | ;; t, nil, 'source, or 'byte; | |
80 | ;; byte-optimize-log Whether to report (in excruciating detail) | |
81 | ;; exactly which optimizations have been made. | |
82 | ;; This may be t, nil, 'source, or 'byte; | |
83 | ;; byte-compile-error-on-warn Whether to stop compilation when a warning is | |
84 | ;; produced; | |
85 | ;; byte-compile-delete-errors Whether the optimizer may delete calls or | |
86 | ;; variable references that are side-effect-free | |
87 | ;; except that they may return an error. | |
88 | ;; byte-compile-generate-call-tree Whether to generate a histogram of | |
89 | ;; function calls. This can be useful for | |
90 | ;; finding unused functions, as well as simple | |
91 | ;; performance metering. | |
92 | ;; byte-compile-warnings List of warnings to issue, or t. May contain | |
93 | ;; 'free-vars (references to variables not in the | |
94 | ;; current lexical scope) | |
95 | ;; 'unresolved (calls to unknown functions) | |
96 | ;; 'callargs (lambda calls with args that don't | |
97 | ;; match the lambda's definition) | |
98 | ;; 'redefine (function cell redefined from | |
99 | ;; a macro to a lambda or vice versa, | |
100 | ;; or redefined to take other args) | |
101 | ;; 'obsolete (obsolete variables and functions) | |
102 | ;; byte-compile-compatibility Whether the compiler should | |
103 | ;; generate .elc files which can be loaded into | |
104 | ;; generic emacs 18. | |
105 | ;; emacs-lisp-file-regexp Regexp for the extension of source-files; | |
106 | ;; see also the function byte-compile-dest-file. | |
107 | ||
108 | ;; New Features: | |
109 | ;; | |
110 | ;; o The form `defsubst' is just like `defun', except that the function | |
111 | ;; generated will be open-coded in compiled code which uses it. This | |
112 | ;; means that no function call will be generated, it will simply be | |
113 | ;; spliced in. Lisp functions calls are very slow, so this can be a | |
114 | ;; big win. | |
115 | ;; | |
116 | ;; You can generally accomplish the same thing with `defmacro', but in | |
117 | ;; that case, the defined procedure can't be used as an argument to | |
118 | ;; mapcar, etc. | |
119 | ;; | |
120 | ;; o You can also open-code one particular call to a function without | |
121 | ;; open-coding all calls. Use the 'inline' form to do this, like so: | |
122 | ;; | |
123 | ;; (inline (foo 1 2 3)) ;; `foo' will be open-coded | |
124 | ;; or... | |
125 | ;; (inline ;; `foo' and `baz' will be | |
126 | ;; (foo 1 2 3 (bar 5)) ;; open-coded, but `bar' will not. | |
127 | ;; (baz 0)) | |
128 | ;; | |
129 | ;; o It is possible to open-code a function in the same file it is defined | |
130 | ;; in without having to load that file before compiling it. the | |
131 | ;; byte-compiler has been modified to remember function definitions in | |
132 | ;; the compilation environment in the same way that it remembers macro | |
133 | ;; definitions. | |
134 | ;; | |
135 | ;; o Forms like ((lambda ...) ...) are open-coded. | |
136 | ;; | |
137 | ;; o The form `eval-when-compile' is like progn, except that the body | |
138 | ;; is evaluated at compile-time. When it appears at top-level, this | |
139 | ;; is analogous to the Common Lisp idiom (eval-when (compile) ...). | |
140 | ;; When it does not appear at top-level, it is similar to the | |
141 | ;; Common Lisp #. reader macro (but not in interpreted code). | |
142 | ;; | |
143 | ;; o The form `eval-and-compile' is similar to eval-when-compile, but | |
144 | ;; the whole form is evalled both at compile-time and at run-time. | |
145 | ;; | |
146 | ;; o The command compile-defun is analogous to eval-defun. | |
147 | ;; | |
148 | ;; o If you run byte-compile-file on a filename which is visited in a | |
149 | ;; buffer, and that buffer is modified, you are asked whether you want | |
150 | ;; to save the buffer before compiling. | |
151 | ;; | |
152 | ;; o byte-compiled files now start with the string `;ELC'. | |
153 | ;; Some versions of `file' can be customized to recognize that. | |
1c393159 | 154 | |
79d52eea JB |
155 | (require 'backquote) |
156 | ||
1c393159 JB |
157 | (or (fboundp 'defsubst) |
158 | ;; This really ought to be loaded already! | |
52799cb8 | 159 | (load-library "byte-run")) |
1c393159 | 160 | |
52799cb8 RS |
161 | ;;; The feature of compiling in a specific target Emacs version |
162 | ;;; has been turned off because compile time options are a bad idea. | |
163 | (defmacro byte-compile-single-version () nil) | |
164 | (defmacro byte-compile-version-cond (cond) cond) | |
1c393159 JB |
165 | |
166 | ;;; The crud you see scattered through this file of the form | |
167 | ;;; (or (and (boundp 'epoch::version) epoch::version) | |
168 | ;;; (string-lessp emacs-version "19")) | |
169 | ;;; is because the Epoch folks couldn't be bothered to follow the | |
170 | ;;; normal emacs version numbering convention. | |
171 | ||
52799cb8 RS |
172 | ;; (if (byte-compile-version-cond |
173 | ;; (or (and (boundp 'epoch::version) epoch::version) | |
174 | ;; (string-lessp emacs-version "19"))) | |
175 | ;; (progn | |
176 | ;; ;; emacs-18 compatibility. | |
177 | ;; (defvar baud-rate (baud-rate)) ;Define baud-rate if it's undefined | |
178 | ;; | |
179 | ;; (if (byte-compile-single-version) | |
ed015bdd JB |
180 | ;; (defmacro byte-code-function-p (x) "Emacs 18 doesn't have these." nil) |
181 | ;; (defun byte-code-function-p (x) "Emacs 18 doesn't have these." nil)) | |
52799cb8 RS |
182 | ;; |
183 | ;; (or (and (fboundp 'member) | |
184 | ;; ;; avoid using someone else's possibly bogus definition of this. | |
185 | ;; (subrp (symbol-function 'member))) | |
186 | ;; (defun member (elt list) | |
187 | ;; "like memq, but uses equal instead of eq. In v19, this is a subr." | |
188 | ;; (while (and list (not (equal elt (car list)))) | |
189 | ;; (setq list (cdr list))) | |
190 | ;; list)))) | |
191 | ||
192 | ||
193 | (defvar emacs-lisp-file-regexp (if (eq system-type 'vax-vms) | |
194 | "\\.EL\\(;[0-9]+\\)?$" | |
195 | "\\.el$") | |
196 | "*Regexp which matches Emacs Lisp source files. | |
197 | You may want to redefine `byte-compile-dest-file' if you change this.") | |
1c393159 | 198 | |
2140206e RS |
199 | ;; This enables file name handlers such as jka-compr |
200 | ;; to remove parts of the file name that should not be copied | |
201 | ;; through to the output file name. | |
202 | (defun byte-compiler-base-file-name (filename) | |
203 | (let ((handler (find-file-name-handler filename | |
204 | 'byte-compiler-base-file-name))) | |
205 | (if handler | |
206 | (funcall handler 'byte-compiler-base-file-name filename) | |
207 | filename))) | |
208 | ||
1c393159 | 209 | (or (fboundp 'byte-compile-dest-file) |
e27c3564 | 210 | ;; The user may want to redefine this along with emacs-lisp-file-regexp, |
1c393159 JB |
211 | ;; so only define it if it is undefined. |
212 | (defun byte-compile-dest-file (filename) | |
52799cb8 | 213 | "Convert an Emacs Lisp source file name to a compiled file name." |
2140206e | 214 | (setq filename (byte-compiler-base-file-name filename)) |
1c393159 JB |
215 | (setq filename (file-name-sans-versions filename)) |
216 | (cond ((eq system-type 'vax-vms) | |
2140206e RS |
217 | (concat (substring filename 0 (string-match ";" filename)) "c")) |
218 | ((string-match emacs-lisp-file-regexp filename) | |
219 | (concat (substring filename 0 (match-beginning 0)) ".elc")) | |
220 | (t (concat filename ".elc"))))) | |
1c393159 JB |
221 | |
222 | ;; This can be the 'byte-compile property of any symbol. | |
52799cb8 | 223 | (autoload 'byte-compile-inline-expand "byte-opt") |
1c393159 JB |
224 | |
225 | ;; This is the entrypoint to the lapcode optimizer pass1. | |
52799cb8 | 226 | (autoload 'byte-optimize-form "byte-opt") |
1c393159 | 227 | ;; This is the entrypoint to the lapcode optimizer pass2. |
52799cb8 RS |
228 | (autoload 'byte-optimize-lapcode "byte-opt") |
229 | (autoload 'byte-compile-unfold-lambda "byte-opt") | |
1c393159 | 230 | |
ed015bdd JB |
231 | ;; This is the entry point to the decompiler, which is used by the |
232 | ;; disassembler. The disassembler just requires 'byte-compile, but | |
233 | ;; that doesn't define this function, so this seems to be a reasonable | |
234 | ;; thing to do. | |
235 | (autoload 'byte-decompile-bytecode "byte-opt") | |
236 | ||
1c393159 JB |
237 | (defvar byte-compile-verbose |
238 | (and (not noninteractive) (> baud-rate search-slow-speed)) | |
239 | "*Non-nil means print messages describing progress of byte-compiler.") | |
240 | ||
52799cb8 RS |
241 | (defvar byte-compile-compatibility nil |
242 | "*Non-nil means generate output that can run in Emacs 18.") | |
243 | ||
244 | ;; (defvar byte-compile-generate-emacs19-bytecodes | |
245 | ;; (not (or (and (boundp 'epoch::version) epoch::version) | |
246 | ;; (string-lessp emacs-version "19"))) | |
247 | ;; "*If this is true, then the byte-compiler will generate bytecode which | |
248 | ;; makes use of byte-ops which are present only in Emacs 19. Code generated | |
249 | ;; this way can never be run in Emacs 18, and may even cause it to crash.") | |
1c393159 JB |
250 | |
251 | (defvar byte-optimize t | |
ab94e6e7 RS |
252 | "*Enables optimization in the byte compiler. |
253 | nil means don't do any optimization. | |
254 | t means do all optimizations. | |
255 | `source' means do source-level optimizations only. | |
256 | `byte' means do code-level optimizations only.") | |
1c393159 JB |
257 | |
258 | (defvar byte-compile-delete-errors t | |
ab94e6e7 RS |
259 | "*If non-nil, the optimizer may delete forms that may signal an error. |
260 | This includes variable references and calls to functions such as `car'.") | |
1c393159 | 261 | |
d82e848c RS |
262 | (defvar byte-compile-dynamic nil |
263 | "*If non-nil, compile function bodies so they load lazily. | |
264 | They are hidden comments in the compiled file, and brought into core when the | |
265 | function is called. | |
266 | ||
267 | To enable this option, make it a file-local variable | |
268 | in the source file you want it to apply to. | |
269 | For example, add -*-byte-compile-dynamic: t;-*- on the first line. | |
270 | ||
271 | When this option is true, if you load the compiled file and then move it, | |
272 | the functions you loaded will not be able to run.") | |
273 | ||
274 | (defvar byte-compile-dynamic-docstrings t | |
275 | "*If non-nil, compile doc strings for lazy access. | |
276 | We bury the doc strings of functions and variables | |
277 | inside comments in the file, and bring them into core only when they | |
278 | are actually needed. | |
279 | ||
280 | When this option is true, if you load the compiled file and then move it, | |
281 | you won't be able to find the documentation of anything in that file. | |
282 | ||
1c660f5a KH |
283 | To disable this option for a certain file, make it a file-local variable |
284 | in the source file. For example, add this to the first line: | |
285 | -*-byte-compile-dynamic-docstrings:nil;-*- | |
286 | You can also set the variable globally. | |
287 | ||
d82e848c RS |
288 | This option is enabled by default because it reduces Emacs memory usage.") |
289 | ||
1c393159 JB |
290 | (defvar byte-optimize-log nil |
291 | "*If true, the byte-compiler will log its optimizations into *Compile-Log*. | |
292 | If this is 'source, then only source-level optimizations will be logged. | |
293 | If it is 'byte, then only byte-level optimizations will be logged.") | |
294 | ||
295 | (defvar byte-compile-error-on-warn nil | |
ab94e6e7 | 296 | "*If true, the byte-compiler reports warnings with `error'.") |
1c393159 | 297 | |
9290191f RS |
298 | (defconst byte-compile-warning-types |
299 | '(redefine callargs free-vars unresolved obsolete)) | |
9e2b097b | 300 | (defvar byte-compile-warnings t |
1c393159 | 301 | "*List of warnings that the byte-compiler should issue (t for all). |
9e2b097b JB |
302 | Elements of the list may be be: |
303 | ||
304 | free-vars references to variables not in the current lexical scope. | |
305 | unresolved calls to unknown functions. | |
306 | callargs lambda calls with args that don't match the definition. | |
307 | redefine function cell redefined from a macro to a lambda or vice | |
308 | versa, or redefined to take a different number of arguments. | |
9290191f | 309 | obsolete obsolete variables and functions. |
9e2b097b | 310 | |
ab94e6e7 | 311 | See also the macro `byte-compiler-options'.") |
1c393159 JB |
312 | |
313 | (defvar byte-compile-generate-call-tree nil | |
52799cb8 RS |
314 | "*Non-nil means collect call-graph information when compiling. |
315 | This records functions were called and from where. | |
316 | If the value is t, compilation displays the call graph when it finishes. | |
317 | If the value is neither t nor nil, compilation asks you whether to display | |
318 | the graph. | |
1c393159 JB |
319 | |
320 | The call tree only lists functions called, not macros used. Those functions | |
321 | which the byte-code interpreter knows about directly (eq, cons, etc.) are | |
322 | not reported. | |
323 | ||
324 | The call tree also lists those functions which are not known to be called | |
5023d9a0 | 325 | \(that is, to which no calls have been compiled). Functions which can be |
1c393159 JB |
326 | invoked interactively are excluded from this list.") |
327 | ||
328 | (defconst byte-compile-call-tree nil "Alist of functions and their call tree. | |
329 | Each element looks like | |
330 | ||
331 | \(FUNCTION CALLERS CALLS\) | |
332 | ||
333 | where CALLERS is a list of functions that call FUNCTION, and CALLS | |
334 | is a list of functions for which calls were generated while compiling | |
335 | FUNCTION.") | |
336 | ||
337 | (defvar byte-compile-call-tree-sort 'name | |
52799cb8 RS |
338 | "*If non-nil, sort the call tree. |
339 | The values `name', `callers', `calls', `calls+callers' | |
340 | specify different fields to sort on.") | |
341 | ||
342 | ;; (defvar byte-compile-overwrite-file t | |
343 | ;; "If nil, old .elc files are deleted before the new is saved, and .elc | |
344 | ;; files will have the same modes as the corresponding .el file. Otherwise, | |
345 | ;; existing .elc files will simply be overwritten, and the existing modes | |
346 | ;; will not be changed. If this variable is nil, then an .elc file which | |
347 | ;; is a symbolic link will be turned into a normal file, instead of the file | |
348 | ;; which the link points to being overwritten.") | |
1c393159 JB |
349 | |
350 | (defvar byte-compile-constants nil | |
351 | "list of all constants encountered during compilation of this form") | |
352 | (defvar byte-compile-variables nil | |
353 | "list of all variables encountered during compilation of this form") | |
354 | (defvar byte-compile-bound-variables nil | |
355 | "list of variables bound in the context of the current form; this list | |
356 | lives partly on the stack.") | |
357 | (defvar byte-compile-free-references) | |
358 | (defvar byte-compile-free-assignments) | |
359 | ||
ab94e6e7 RS |
360 | (defvar byte-compiler-error-flag) |
361 | ||
1c393159 | 362 | (defconst byte-compile-initial-macro-environment |
52799cb8 RS |
363 | '( |
364 | ;; (byte-compiler-options . (lambda (&rest forms) | |
365 | ;; (apply 'byte-compiler-options-handler forms))) | |
1c393159 JB |
366 | (eval-when-compile . (lambda (&rest body) |
367 | (list 'quote (eval (byte-compile-top-level | |
368 | (cons 'progn body)))))) | |
369 | (eval-and-compile . (lambda (&rest body) | |
370 | (eval (cons 'progn body)) | |
371 | (cons 'progn body)))) | |
372 | "The default macro-environment passed to macroexpand by the compiler. | |
373 | Placing a macro here will cause a macro to have different semantics when | |
374 | expanded by the compiler as when expanded by the interpreter.") | |
375 | ||
376 | (defvar byte-compile-macro-environment byte-compile-initial-macro-environment | |
52799cb8 RS |
377 | "Alist of macros defined in the file being compiled. |
378 | Each element looks like (MACRONAME . DEFINITION). It is | |
e27c3564 | 379 | \(MACRONAME . nil) when a macro is redefined as a function.") |
1c393159 JB |
380 | |
381 | (defvar byte-compile-function-environment nil | |
52799cb8 RS |
382 | "Alist of functions defined in the file being compiled. |
383 | This is so we can inline them when necessary. | |
384 | Each element looks like (FUNCTIONNAME . DEFINITION). It is | |
385 | \(FUNCTIONNAME . nil) when a function is redefined as a macro.") | |
1c393159 JB |
386 | |
387 | (defvar byte-compile-unresolved-functions nil | |
388 | "Alist of undefined functions to which calls have been compiled (used for | |
389 | warnings when the function is later defined with incorrect args).") | |
390 | ||
391 | (defvar byte-compile-tag-number 0) | |
392 | (defvar byte-compile-output nil | |
393 | "Alist describing contents to put in byte code string. | |
394 | Each element is (INDEX . VALUE)") | |
395 | (defvar byte-compile-depth 0 "Current depth of execution stack.") | |
396 | (defvar byte-compile-maxdepth 0 "Maximum depth of execution stack.") | |
397 | ||
398 | \f | |
399 | ;;; The byte codes; this information is duplicated in bytecomp.c | |
400 | ||
401 | (defconst byte-code-vector nil | |
402 | "An array containing byte-code names indexed by byte-code values.") | |
403 | ||
404 | (defconst byte-stack+-info nil | |
405 | "An array with the stack adjustment for each byte-code.") | |
406 | ||
407 | (defmacro byte-defop (opcode stack-adjust opname &optional docstring) | |
408 | ;; This is a speed-hack for building the byte-code-vector at compile-time. | |
409 | ;; We fill in the vector at macroexpand-time, and then after the last call | |
410 | ;; to byte-defop, we write the vector out as a constant instead of writing | |
411 | ;; out a bunch of calls to aset. | |
412 | ;; Actually, we don't fill in the vector itself, because that could make | |
413 | ;; it problematic to compile big changes to this compiler; we store the | |
414 | ;; values on its plist, and remove them later in -extrude. | |
415 | (let ((v1 (or (get 'byte-code-vector 'tmp-compile-time-value) | |
416 | (put 'byte-code-vector 'tmp-compile-time-value | |
417 | (make-vector 256 nil)))) | |
418 | (v2 (or (get 'byte-stack+-info 'tmp-compile-time-value) | |
419 | (put 'byte-stack+-info 'tmp-compile-time-value | |
420 | (make-vector 256 nil))))) | |
421 | (aset v1 opcode opname) | |
422 | (aset v2 opcode stack-adjust)) | |
423 | (if docstring | |
424 | (list 'defconst opname opcode (concat "Byte code opcode " docstring ".")) | |
425 | (list 'defconst opname opcode))) | |
426 | ||
427 | (defmacro byte-extrude-byte-code-vectors () | |
428 | (prog1 (list 'setq 'byte-code-vector | |
429 | (get 'byte-code-vector 'tmp-compile-time-value) | |
430 | 'byte-stack+-info | |
431 | (get 'byte-stack+-info 'tmp-compile-time-value)) | |
432 | ;; emacs-18 has no REMPROP. | |
433 | (put 'byte-code-vector 'tmp-compile-time-value nil) | |
434 | (put 'byte-stack+-info 'tmp-compile-time-value nil))) | |
435 | ||
436 | ||
437 | ;; unused: 0-7 | |
438 | ||
439 | ;; These opcodes are special in that they pack their argument into the | |
440 | ;; opcode word. | |
441 | ;; | |
442 | (byte-defop 8 1 byte-varref "for variable reference") | |
443 | (byte-defop 16 -1 byte-varset "for setting a variable") | |
444 | (byte-defop 24 -1 byte-varbind "for binding a variable") | |
445 | (byte-defop 32 0 byte-call "for calling a function") | |
446 | (byte-defop 40 0 byte-unbind "for unbinding special bindings") | |
eb8c3be9 | 447 | ;; codes 8-47 are consumed by the preceding opcodes |
1c393159 JB |
448 | |
449 | ;; unused: 48-55 | |
450 | ||
451 | (byte-defop 56 -1 byte-nth) | |
452 | (byte-defop 57 0 byte-symbolp) | |
453 | (byte-defop 58 0 byte-consp) | |
454 | (byte-defop 59 0 byte-stringp) | |
455 | (byte-defop 60 0 byte-listp) | |
456 | (byte-defop 61 -1 byte-eq) | |
457 | (byte-defop 62 -1 byte-memq) | |
458 | (byte-defop 63 0 byte-not) | |
459 | (byte-defop 64 0 byte-car) | |
460 | (byte-defop 65 0 byte-cdr) | |
461 | (byte-defop 66 -1 byte-cons) | |
462 | (byte-defop 67 0 byte-list1) | |
463 | (byte-defop 68 -1 byte-list2) | |
464 | (byte-defop 69 -2 byte-list3) | |
465 | (byte-defop 70 -3 byte-list4) | |
466 | (byte-defop 71 0 byte-length) | |
467 | (byte-defop 72 -1 byte-aref) | |
468 | (byte-defop 73 -2 byte-aset) | |
469 | (byte-defop 74 0 byte-symbol-value) | |
470 | (byte-defop 75 0 byte-symbol-function) ; this was commented out | |
471 | (byte-defop 76 -1 byte-set) | |
472 | (byte-defop 77 -1 byte-fset) ; this was commented out | |
473 | (byte-defop 78 -1 byte-get) | |
474 | (byte-defop 79 -2 byte-substring) | |
475 | (byte-defop 80 -1 byte-concat2) | |
476 | (byte-defop 81 -2 byte-concat3) | |
477 | (byte-defop 82 -3 byte-concat4) | |
478 | (byte-defop 83 0 byte-sub1) | |
479 | (byte-defop 84 0 byte-add1) | |
480 | (byte-defop 85 -1 byte-eqlsign) | |
481 | (byte-defop 86 -1 byte-gtr) | |
482 | (byte-defop 87 -1 byte-lss) | |
483 | (byte-defop 88 -1 byte-leq) | |
484 | (byte-defop 89 -1 byte-geq) | |
485 | (byte-defop 90 -1 byte-diff) | |
486 | (byte-defop 91 0 byte-negate) | |
487 | (byte-defop 92 -1 byte-plus) | |
488 | (byte-defop 93 -1 byte-max) | |
489 | (byte-defop 94 -1 byte-min) | |
490 | (byte-defop 95 -1 byte-mult) ; v19 only | |
491 | (byte-defop 96 1 byte-point) | |
1c393159 JB |
492 | (byte-defop 98 0 byte-goto-char) |
493 | (byte-defop 99 0 byte-insert) | |
494 | (byte-defop 100 1 byte-point-max) | |
495 | (byte-defop 101 1 byte-point-min) | |
496 | (byte-defop 102 0 byte-char-after) | |
497 | (byte-defop 103 1 byte-following-char) | |
498 | (byte-defop 104 1 byte-preceding-char) | |
499 | (byte-defop 105 1 byte-current-column) | |
500 | (byte-defop 106 0 byte-indent-to) | |
501 | (byte-defop 107 0 byte-scan-buffer-OBSOLETE) ; no longer generated as of v18 | |
502 | (byte-defop 108 1 byte-eolp) | |
503 | (byte-defop 109 1 byte-eobp) | |
504 | (byte-defop 110 1 byte-bolp) | |
505 | (byte-defop 111 1 byte-bobp) | |
506 | (byte-defop 112 1 byte-current-buffer) | |
507 | (byte-defop 113 0 byte-set-buffer) | |
78943c8a RS |
508 | (byte-defop 114 0 byte-save-current-buffer |
509 | "To make a binding to record the current buffer") | |
1c393159 JB |
510 | (byte-defop 115 0 byte-set-mark-OBSOLETE) |
511 | (byte-defop 116 1 byte-interactive-p) | |
512 | ||
513 | ;; These ops are new to v19 | |
514 | (byte-defop 117 0 byte-forward-char) | |
515 | (byte-defop 118 0 byte-forward-word) | |
516 | (byte-defop 119 -1 byte-skip-chars-forward) | |
517 | (byte-defop 120 -1 byte-skip-chars-backward) | |
518 | (byte-defop 121 0 byte-forward-line) | |
519 | (byte-defop 122 0 byte-char-syntax) | |
520 | (byte-defop 123 -1 byte-buffer-substring) | |
521 | (byte-defop 124 -1 byte-delete-region) | |
522 | (byte-defop 125 -1 byte-narrow-to-region) | |
523 | (byte-defop 126 1 byte-widen) | |
524 | (byte-defop 127 0 byte-end-of-line) | |
525 | ||
526 | ;; unused: 128 | |
527 | ||
528 | ;; These store their argument in the next two bytes | |
529 | (byte-defop 129 1 byte-constant2 | |
530 | "for reference to a constant with vector index >= byte-constant-limit") | |
531 | (byte-defop 130 0 byte-goto "for unconditional jump") | |
532 | (byte-defop 131 -1 byte-goto-if-nil "to pop value and jump if it's nil") | |
533 | (byte-defop 132 -1 byte-goto-if-not-nil "to pop value and jump if it's not nil") | |
534 | (byte-defop 133 -1 byte-goto-if-nil-else-pop | |
535 | "to examine top-of-stack, jump and don't pop it if it's nil, | |
536 | otherwise pop it") | |
537 | (byte-defop 134 -1 byte-goto-if-not-nil-else-pop | |
538 | "to examine top-of-stack, jump and don't pop it if it's non nil, | |
539 | otherwise pop it") | |
540 | ||
541 | (byte-defop 135 -1 byte-return "to pop a value and return it from `byte-code'") | |
542 | (byte-defop 136 -1 byte-discard "to discard one value from stack") | |
543 | (byte-defop 137 1 byte-dup "to duplicate the top of the stack") | |
544 | ||
545 | (byte-defop 138 0 byte-save-excursion | |
546 | "to make a binding to record the buffer, point and mark") | |
547 | (byte-defop 139 0 byte-save-window-excursion | |
548 | "to make a binding to record entire window configuration") | |
549 | (byte-defop 140 0 byte-save-restriction | |
550 | "to make a binding to record the current buffer clipping restrictions") | |
551 | (byte-defop 141 -1 byte-catch | |
552 | "for catch. Takes, on stack, the tag and an expression for the body") | |
553 | (byte-defop 142 -1 byte-unwind-protect | |
554 | "for unwind-protect. Takes, on stack, an expression for the unwind-action") | |
555 | ||
52799cb8 RS |
556 | ;; For condition-case. Takes, on stack, the variable to bind, |
557 | ;; an expression for the body, and a list of clauses. | |
558 | (byte-defop 143 -2 byte-condition-case) | |
1c393159 | 559 | |
52799cb8 RS |
560 | ;; For entry to with-output-to-temp-buffer. |
561 | ;; Takes, on stack, the buffer name. | |
562 | ;; Binds standard-output and does some other things. | |
563 | ;; Returns with temp buffer on the stack in place of buffer name. | |
564 | (byte-defop 144 0 byte-temp-output-buffer-setup) | |
1c393159 | 565 | |
52799cb8 RS |
566 | ;; For exit from with-output-to-temp-buffer. |
567 | ;; Expects the temp buffer on the stack underneath value to return. | |
568 | ;; Pops them both, then pushes the value back on. | |
569 | ;; Unbinds standard-output and makes the temp buffer visible. | |
570 | (byte-defop 145 -1 byte-temp-output-buffer-show) | |
1c393159 JB |
571 | |
572 | ;; these ops are new to v19 | |
52799cb8 RS |
573 | |
574 | ;; To unbind back to the beginning of this frame. | |
69dc83fd | 575 | ;; Not used yet, but will be needed for tail-recursion elimination. |
52799cb8 | 576 | (byte-defop 146 0 byte-unbind-all) |
1c393159 JB |
577 | |
578 | ;; these ops are new to v19 | |
579 | (byte-defop 147 -2 byte-set-marker) | |
580 | (byte-defop 148 0 byte-match-beginning) | |
581 | (byte-defop 149 0 byte-match-end) | |
582 | (byte-defop 150 0 byte-upcase) | |
583 | (byte-defop 151 0 byte-downcase) | |
584 | (byte-defop 152 -1 byte-string=) | |
585 | (byte-defop 153 -1 byte-string<) | |
586 | (byte-defop 154 -1 byte-equal) | |
587 | (byte-defop 155 -1 byte-nthcdr) | |
588 | (byte-defop 156 -1 byte-elt) | |
589 | (byte-defop 157 -1 byte-member) | |
590 | (byte-defop 158 -1 byte-assq) | |
591 | (byte-defop 159 0 byte-nreverse) | |
592 | (byte-defop 160 -1 byte-setcar) | |
593 | (byte-defop 161 -1 byte-setcdr) | |
594 | (byte-defop 162 0 byte-car-safe) | |
595 | (byte-defop 163 0 byte-cdr-safe) | |
596 | (byte-defop 164 -1 byte-nconc) | |
597 | (byte-defop 165 -1 byte-quo) | |
598 | (byte-defop 166 -1 byte-rem) | |
599 | (byte-defop 167 0 byte-numberp) | |
600 | (byte-defop 168 0 byte-integerp) | |
601 | ||
3eac9910 | 602 | ;; unused: 169-174 |
1c393159 JB |
603 | (byte-defop 175 nil byte-listN) |
604 | (byte-defop 176 nil byte-concatN) | |
605 | (byte-defop 177 nil byte-insertN) | |
606 | ||
607 | ;; unused: 178-191 | |
608 | ||
609 | (byte-defop 192 1 byte-constant "for reference to a constant") | |
610 | ;; codes 193-255 are consumed by byte-constant. | |
611 | (defconst byte-constant-limit 64 | |
612 | "Exclusive maximum index usable in the `byte-constant' opcode.") | |
613 | ||
614 | (defconst byte-goto-ops '(byte-goto byte-goto-if-nil byte-goto-if-not-nil | |
615 | byte-goto-if-nil-else-pop | |
616 | byte-goto-if-not-nil-else-pop) | |
52799cb8 | 617 | "List of byte-codes whose offset is a pc.") |
1c393159 JB |
618 | |
619 | (defconst byte-goto-always-pop-ops '(byte-goto-if-nil byte-goto-if-not-nil)) | |
620 | ||
1c393159 JB |
621 | (byte-extrude-byte-code-vectors) |
622 | \f | |
623 | ;;; lapcode generator | |
624 | ;;; | |
625 | ;;; the byte-compiler now does source -> lapcode -> bytecode instead of | |
626 | ;;; source -> bytecode, because it's a lot easier to make optimizations | |
627 | ;;; on lapcode than on bytecode. | |
628 | ;;; | |
629 | ;;; Elements of the lapcode list are of the form (<instruction> . <parameter>) | |
630 | ;;; where instruction is a symbol naming a byte-code instruction, | |
631 | ;;; and parameter is an argument to that instruction, if any. | |
632 | ;;; | |
633 | ;;; The instruction can be the pseudo-op TAG, which means that this position | |
634 | ;;; in the instruction stream is a target of a goto. (car PARAMETER) will be | |
635 | ;;; the PC for this location, and the whole instruction "(TAG pc)" will be the | |
636 | ;;; parameter for some goto op. | |
637 | ;;; | |
638 | ;;; If the operation is varbind, varref, varset or push-constant, then the | |
639 | ;;; parameter is (variable/constant . index_in_constant_vector). | |
640 | ;;; | |
641 | ;;; First, the source code is macroexpanded and optimized in various ways. | |
642 | ;;; Then the resultant code is compiled into lapcode. Another set of | |
643 | ;;; optimizations are then run over the lapcode. Then the variables and | |
644 | ;;; constants referenced by the lapcode are collected and placed in the | |
645 | ;;; constants-vector. (This happens now so that variables referenced by dead | |
646 | ;;; code don't consume space.) And finally, the lapcode is transformed into | |
647 | ;;; compacted byte-code. | |
648 | ;;; | |
649 | ;;; A distinction is made between variables and constants because the variable- | |
650 | ;;; referencing instructions are more sensitive to the variables being near the | |
651 | ;;; front of the constants-vector than the constant-referencing instructions. | |
652 | ;;; Also, this lets us notice references to free variables. | |
653 | ||
654 | (defun byte-compile-lapcode (lap) | |
655 | "Turns lapcode into bytecode. The lapcode is destroyed." | |
656 | ;; Lapcode modifications: changes the ID of a tag to be the tag's PC. | |
657 | (let ((pc 0) ; Program counter | |
658 | op off ; Operation & offset | |
659 | (bytes '()) ; Put the output bytes here | |
660 | (patchlist nil) ; List of tags and goto's to patch | |
661 | rest rel tmp) | |
662 | (while lap | |
663 | (setq op (car (car lap)) | |
664 | off (cdr (car lap))) | |
665 | (cond ((not (symbolp op)) | |
52799cb8 | 666 | (error "Non-symbolic opcode `%s'" op)) |
1c393159 JB |
667 | ((eq op 'TAG) |
668 | (setcar off pc) | |
669 | (setq patchlist (cons off patchlist))) | |
670 | ((memq op byte-goto-ops) | |
671 | (setq pc (+ pc 3)) | |
672 | (setq bytes (cons (cons pc (cdr off)) | |
673 | (cons nil | |
674 | (cons (symbol-value op) bytes)))) | |
675 | (setq patchlist (cons bytes patchlist))) | |
676 | (t | |
677 | (setq bytes | |
678 | (cond ((cond ((consp off) | |
679 | ;; Variable or constant reference | |
680 | (setq off (cdr off)) | |
681 | (eq op 'byte-constant))) | |
682 | (cond ((< off byte-constant-limit) | |
683 | (setq pc (1+ pc)) | |
684 | (cons (+ byte-constant off) bytes)) | |
685 | (t | |
686 | (setq pc (+ 3 pc)) | |
687 | (cons (lsh off -8) | |
688 | (cons (logand off 255) | |
689 | (cons byte-constant2 bytes)))))) | |
690 | ((<= byte-listN (symbol-value op)) | |
691 | (setq pc (+ 2 pc)) | |
692 | (cons off (cons (symbol-value op) bytes))) | |
693 | ((< off 6) | |
694 | (setq pc (1+ pc)) | |
695 | (cons (+ (symbol-value op) off) bytes)) | |
696 | ((< off 256) | |
697 | (setq pc (+ 2 pc)) | |
698 | (cons off (cons (+ (symbol-value op) 6) bytes))) | |
699 | (t | |
700 | (setq pc (+ 3 pc)) | |
701 | (cons (lsh off -8) | |
702 | (cons (logand off 255) | |
703 | (cons (+ (symbol-value op) 7) | |
704 | bytes)))))))) | |
705 | (setq lap (cdr lap))) | |
706 | ;;(if (not (= pc (length bytes))) | |
52799cb8 | 707 | ;; (error "Compiler error: pc mismatch - %s %s" pc (length bytes))) |
1c393159 JB |
708 | ;; Patch PC into jumps |
709 | (let (bytes) | |
710 | (while patchlist | |
711 | (setq bytes (car patchlist)) | |
712 | (cond ((atom (car bytes))) ; Tag | |
1c393159 JB |
713 | (t ; Absolute jump |
714 | (setq pc (car (cdr (car bytes)))) ; Pick PC from tag | |
715 | (setcar (cdr bytes) (logand pc 255)) | |
716 | (setcar bytes (lsh pc -8)))) | |
717 | (setq patchlist (cdr patchlist)))) | |
718 | (concat (nreverse bytes)))) | |
719 | ||
720 | \f | |
721 | ;;; byte compiler messages | |
722 | ||
d82e848c RS |
723 | (defvar byte-compile-current-form nil) |
724 | (defvar byte-compile-current-file nil) | |
725 | (defvar byte-compile-dest-file nil) | |
1c393159 JB |
726 | |
727 | (defmacro byte-compile-log (format-string &rest args) | |
728 | (list 'and | |
729 | 'byte-optimize | |
730 | '(memq byte-optimize-log '(t source)) | |
731 | (list 'let '((print-escape-newlines t) | |
732 | (print-level 4) | |
733 | (print-length 4)) | |
734 | (list 'byte-compile-log-1 | |
735 | (cons 'format | |
736 | (cons format-string | |
737 | (mapcar | |
738 | '(lambda (x) | |
739 | (if (symbolp x) (list 'prin1-to-string x) x)) | |
740 | args))))))) | |
741 | ||
742 | (defconst byte-compile-last-warned-form nil) | |
743 | ||
144b2637 RS |
744 | ;; Log a message STRING in *Compile-Log*. |
745 | ;; Also log the current function and file if not already done. | |
9e2b097b | 746 | (defun byte-compile-log-1 (string &optional fill) |
1c393159 JB |
747 | (cond (noninteractive |
748 | (if (or byte-compile-current-file | |
749 | (and byte-compile-last-warned-form | |
750 | (not (eq byte-compile-current-form | |
751 | byte-compile-last-warned-form)))) | |
7e084653 KH |
752 | (message "While compiling %s%s:" |
753 | (or byte-compile-current-form "toplevel forms") | |
754 | (if byte-compile-current-file | |
755 | (if (stringp byte-compile-current-file) | |
756 | (concat " in file " byte-compile-current-file) | |
757 | (concat " in buffer " | |
758 | (buffer-name byte-compile-current-file))) | |
759 | ""))) | |
1c393159 JB |
760 | (message " %s" string)) |
761 | (t | |
762 | (save-excursion | |
763 | (set-buffer (get-buffer-create "*Compile-Log*")) | |
764 | (goto-char (point-max)) | |
765 | (cond ((or byte-compile-current-file | |
766 | (and byte-compile-last-warned-form | |
767 | (not (eq byte-compile-current-form | |
768 | byte-compile-last-warned-form)))) | |
769 | (if byte-compile-current-file | |
770 | (insert "\n\^L\n" (current-time-string) "\n")) | |
771 | (insert "While compiling " | |
772 | (if byte-compile-current-form | |
773 | (format "%s" byte-compile-current-form) | |
774 | "toplevel forms")) | |
775 | (if byte-compile-current-file | |
776 | (if (stringp byte-compile-current-file) | |
777 | (insert " in file " byte-compile-current-file) | |
778 | (insert " in buffer " | |
779 | (buffer-name byte-compile-current-file)))) | |
780 | (insert ":\n"))) | |
9e2b097b JB |
781 | (insert " " string "\n") |
782 | (if (and fill (not (string-match "\n" string))) | |
783 | (let ((fill-prefix " ") | |
784 | (fill-column 78)) | |
785 | (fill-paragraph nil))) | |
786 | ))) | |
1c393159 JB |
787 | (setq byte-compile-current-file nil |
788 | byte-compile-last-warned-form byte-compile-current-form)) | |
789 | ||
144b2637 RS |
790 | ;; Log the start of a file in *Compile-Log*, and mark it as done. |
791 | ;; But do nothing in batch mode. | |
792 | (defun byte-compile-log-file () | |
793 | (and byte-compile-current-file (not noninteractive) | |
794 | (save-excursion | |
795 | (set-buffer (get-buffer-create "*Compile-Log*")) | |
ca96ae0b | 796 | (goto-char (point-max)) |
144b2637 RS |
797 | (insert "\n\^L\nCompiling " |
798 | (if (stringp byte-compile-current-file) | |
799 | (concat "file " byte-compile-current-file) | |
800 | (concat "buffer " (buffer-name byte-compile-current-file))) | |
801 | " at " (current-time-string) "\n") | |
802 | (setq byte-compile-current-file nil)))) | |
803 | ||
1c393159 JB |
804 | (defun byte-compile-warn (format &rest args) |
805 | (setq format (apply 'format format args)) | |
806 | (if byte-compile-error-on-warn | |
807 | (error "%s" format) ; byte-compile-file catches and logs it | |
9e2b097b | 808 | (byte-compile-log-1 (concat "** " format) t) |
fd5285f3 RS |
809 | ;;; It is useless to flash warnings too fast to be read. |
810 | ;;; Besides, they will all be shown at the end. | |
811 | ;;; (or noninteractive ; already written on stdout. | |
812 | ;;; (message "Warning: %s" format)) | |
813 | )) | |
1c393159 | 814 | |
0b030df7 JB |
815 | ;;; This function should be used to report errors that have halted |
816 | ;;; compilation of the current file. | |
817 | (defun byte-compile-report-error (error-info) | |
ab94e6e7 | 818 | (setq byte-compiler-error-flag t) |
9e2b097b JB |
819 | (byte-compile-log-1 |
820 | (concat "!! " | |
821 | (format (if (cdr error-info) "%s (%s)" "%s") | |
822 | (get (car error-info) 'error-message) | |
823 | (prin1-to-string (cdr error-info)))))) | |
0b030df7 | 824 | |
1c393159 JB |
825 | ;;; Used by make-obsolete. |
826 | (defun byte-compile-obsolete (form) | |
e0b93488 RS |
827 | (let ((new (get (car form) 'byte-obsolete-info))) |
828 | (if (memq 'obsolete byte-compile-warnings) | |
9290191f RS |
829 | (byte-compile-warn "%s is an obsolete function; %s" (car form) |
830 | (if (stringp (car new)) | |
831 | (car new) | |
e0b93488 RS |
832 | (format "use %s instead." (car new))))) |
833 | (funcall (or (cdr new) 'byte-compile-normal-call) form))) | |
1c393159 JB |
834 | \f |
835 | ;; Compiler options | |
836 | ||
52799cb8 RS |
837 | ;; (defvar byte-compiler-valid-options |
838 | ;; '((optimize byte-optimize (t nil source byte) val) | |
839 | ;; (file-format byte-compile-compatibility (emacs18 emacs19) | |
840 | ;; (eq val 'emacs18)) | |
841 | ;; ;; (new-bytecodes byte-compile-generate-emacs19-bytecodes (t nil) val) | |
842 | ;; (delete-errors byte-compile-delete-errors (t nil) val) | |
843 | ;; (verbose byte-compile-verbose (t nil) val) | |
844 | ;; (warnings byte-compile-warnings ((callargs redefine free-vars unresolved)) | |
845 | ;; val))) | |
1c393159 JB |
846 | |
847 | ;; Inhibit v18/v19 selectors if the version is hardcoded. | |
848 | ;; #### This should print a warning if the user tries to change something | |
849 | ;; than can't be changed because the running compiler doesn't support it. | |
52799cb8 RS |
850 | ;; (cond |
851 | ;; ((byte-compile-single-version) | |
852 | ;; (setcar (cdr (cdr (assq 'new-bytecodes byte-compiler-valid-options))) | |
853 | ;; (list (byte-compile-version-cond | |
854 | ;; byte-compile-generate-emacs19-bytecodes))) | |
855 | ;; (setcar (cdr (cdr (assq 'file-format byte-compiler-valid-options))) | |
856 | ;; (if (byte-compile-version-cond byte-compile-compatibility) | |
857 | ;; '(emacs18) '(emacs19))))) | |
858 | ||
859 | ;; (defun byte-compiler-options-handler (&rest args) | |
860 | ;; (let (key val desc choices) | |
861 | ;; (while args | |
862 | ;; (if (or (atom (car args)) (nthcdr 2 (car args)) (null (cdr (car args)))) | |
863 | ;; (error "Malformed byte-compiler option `%s'" (car args))) | |
864 | ;; (setq key (car (car args)) | |
865 | ;; val (car (cdr (car args))) | |
866 | ;; desc (assq key byte-compiler-valid-options)) | |
867 | ;; (or desc | |
868 | ;; (error "Unknown byte-compiler option `%s'" key)) | |
869 | ;; (setq choices (nth 2 desc)) | |
870 | ;; (if (consp (car choices)) | |
871 | ;; (let (this | |
872 | ;; (handler 'cons) | |
873 | ;; (ret (and (memq (car val) '(+ -)) | |
874 | ;; (copy-sequence (if (eq t (symbol-value (nth 1 desc))) | |
875 | ;; choices | |
876 | ;; (symbol-value (nth 1 desc))))))) | |
877 | ;; (setq choices (car choices)) | |
878 | ;; (while val | |
879 | ;; (setq this (car val)) | |
880 | ;; (cond ((memq this choices) | |
881 | ;; (setq ret (funcall handler this ret))) | |
882 | ;; ((eq this '+) (setq handler 'cons)) | |
883 | ;; ((eq this '-) (setq handler 'delq)) | |
884 | ;; ((error "`%s' only accepts %s" key choices))) | |
885 | ;; (setq val (cdr val))) | |
886 | ;; (set (nth 1 desc) ret)) | |
887 | ;; (or (memq val choices) | |
888 | ;; (error "`%s' must be one of `%s'" key choices)) | |
889 | ;; (set (nth 1 desc) (eval (nth 3 desc)))) | |
890 | ;; (setq args (cdr args))) | |
891 | ;; nil)) | |
1c393159 JB |
892 | \f |
893 | ;;; sanity-checking arglists | |
894 | ||
895 | (defun byte-compile-fdefinition (name macro-p) | |
896 | (let* ((list (if macro-p | |
897 | byte-compile-macro-environment | |
5286a842 | 898 | byte-compile-function-environment)) |
1c393159 JB |
899 | (env (cdr (assq name list)))) |
900 | (or env | |
901 | (let ((fn name)) | |
902 | (while (and (symbolp fn) | |
903 | (fboundp fn) | |
904 | (or (symbolp (symbol-function fn)) | |
905 | (consp (symbol-function fn)) | |
906 | (and (not macro-p) | |
ed015bdd | 907 | (byte-code-function-p (symbol-function fn))))) |
1c393159 | 908 | (setq fn (symbol-function fn))) |
ed015bdd | 909 | (if (and (not macro-p) (byte-code-function-p fn)) |
1c393159 JB |
910 | fn |
911 | (and (consp fn) | |
912 | (if (eq 'macro (car fn)) | |
913 | (cdr fn) | |
914 | (if macro-p | |
915 | nil | |
916 | (if (eq 'autoload (car fn)) | |
917 | nil | |
918 | fn))))))))) | |
919 | ||
920 | (defun byte-compile-arglist-signature (arglist) | |
921 | (let ((args 0) | |
922 | opts | |
923 | restp) | |
924 | (while arglist | |
925 | (cond ((eq (car arglist) '&optional) | |
926 | (or opts (setq opts 0))) | |
927 | ((eq (car arglist) '&rest) | |
928 | (if (cdr arglist) | |
929 | (setq restp t | |
930 | arglist nil))) | |
931 | (t | |
932 | (if opts | |
933 | (setq opts (1+ opts)) | |
934 | (setq args (1+ args))))) | |
935 | (setq arglist (cdr arglist))) | |
936 | (cons args (if restp nil (if opts (+ args opts) args))))) | |
937 | ||
938 | ||
939 | (defun byte-compile-arglist-signatures-congruent-p (old new) | |
940 | (not (or | |
941 | (> (car new) (car old)) ; requires more args now | |
a7acbbe4 | 942 | (and (null (cdr old)) ; took rest-args, doesn't any more |
1c393159 JB |
943 | (cdr new)) |
944 | (and (cdr new) (cdr old) ; can't take as many args now | |
945 | (< (cdr new) (cdr old))) | |
946 | ))) | |
947 | ||
948 | (defun byte-compile-arglist-signature-string (signature) | |
949 | (cond ((null (cdr signature)) | |
950 | (format "%d+" (car signature))) | |
951 | ((= (car signature) (cdr signature)) | |
952 | (format "%d" (car signature))) | |
953 | (t (format "%d-%d" (car signature) (cdr signature))))) | |
954 | ||
955 | ||
52799cb8 | 956 | ;; Warn if the form is calling a function with the wrong number of arguments. |
1c393159 | 957 | (defun byte-compile-callargs-warn (form) |
1c393159 JB |
958 | (let* ((def (or (byte-compile-fdefinition (car form) nil) |
959 | (byte-compile-fdefinition (car form) t))) | |
960 | (sig (and def (byte-compile-arglist-signature | |
961 | (if (eq 'lambda (car-safe def)) | |
962 | (nth 1 def) | |
d82e848c | 963 | (if (byte-code-function-p def) |
5286a842 RS |
964 | (aref def 0) |
965 | '(&rest def)))))) | |
1c393159 JB |
966 | (ncall (length (cdr form)))) |
967 | (if sig | |
968 | (if (or (< ncall (car sig)) | |
969 | (and (cdr sig) (> ncall (cdr sig)))) | |
970 | (byte-compile-warn | |
971 | "%s called with %d argument%s, but %s %s" | |
972 | (car form) ncall | |
973 | (if (= 1 ncall) "" "s") | |
974 | (if (< ncall (car sig)) | |
975 | "requires" | |
976 | "accepts only") | |
977 | (byte-compile-arglist-signature-string sig))) | |
978 | (or (fboundp (car form)) ; might be a subr or autoload. | |
979 | (eq (car form) byte-compile-current-form) ; ## this doesn't work with recursion. | |
980 | ;; It's a currently-undefined function. Remember number of args in call. | |
981 | (let ((cons (assq (car form) byte-compile-unresolved-functions)) | |
982 | (n (length (cdr form)))) | |
983 | (if cons | |
984 | (or (memq n (cdr cons)) | |
985 | (setcdr cons (cons n (cdr cons)))) | |
986 | (setq byte-compile-unresolved-functions | |
987 | (cons (list (car form) n) | |
988 | byte-compile-unresolved-functions)))))))) | |
989 | ||
52799cb8 RS |
990 | ;; Warn if the function or macro is being redefined with a different |
991 | ;; number of arguments. | |
1c393159 | 992 | (defun byte-compile-arglist-warn (form macrop) |
1c393159 JB |
993 | (let ((old (byte-compile-fdefinition (nth 1 form) macrop))) |
994 | (if old | |
995 | (let ((sig1 (byte-compile-arglist-signature | |
996 | (if (eq 'lambda (car-safe old)) | |
997 | (nth 1 old) | |
d82e848c | 998 | (if (byte-code-function-p old) |
5286a842 RS |
999 | (aref old 0) |
1000 | '(&rest def))))) | |
1c393159 JB |
1001 | (sig2 (byte-compile-arglist-signature (nth 2 form)))) |
1002 | (or (byte-compile-arglist-signatures-congruent-p sig1 sig2) | |
1003 | (byte-compile-warn "%s %s used to take %s %s, now takes %s" | |
1004 | (if (eq (car form) 'defun) "function" "macro") | |
1005 | (nth 1 form) | |
1006 | (byte-compile-arglist-signature-string sig1) | |
1007 | (if (equal sig1 '(1 . 1)) "argument" "arguments") | |
1008 | (byte-compile-arglist-signature-string sig2)))) | |
1009 | ;; This is the first definition. See if previous calls are compatible. | |
1010 | (let ((calls (assq (nth 1 form) byte-compile-unresolved-functions)) | |
1011 | nums sig min max) | |
1012 | (if calls | |
1013 | (progn | |
1014 | (setq sig (byte-compile-arglist-signature (nth 2 form)) | |
1015 | nums (sort (copy-sequence (cdr calls)) (function <)) | |
1016 | min (car nums) | |
1017 | max (car (nreverse nums))) | |
1018 | (if (or (< min (car sig)) | |
1019 | (and (cdr sig) (> max (cdr sig)))) | |
1020 | (byte-compile-warn | |
1021 | "%s being defined to take %s%s, but was previously called with %s" | |
1022 | (nth 1 form) | |
1023 | (byte-compile-arglist-signature-string sig) | |
1024 | (if (equal sig '(1 . 1)) " arg" " args") | |
1025 | (byte-compile-arglist-signature-string (cons min max)))) | |
1026 | ||
1027 | (setq byte-compile-unresolved-functions | |
1028 | (delq calls byte-compile-unresolved-functions))))) | |
1029 | ))) | |
1030 | ||
52799cb8 RS |
1031 | ;; If we have compiled any calls to functions which are not known to be |
1032 | ;; defined, issue a warning enumerating them. | |
1033 | ;; `unresolved' in the list `byte-compile-warnings' disables this. | |
1c393159 | 1034 | (defun byte-compile-warn-about-unresolved-functions () |
1c393159 JB |
1035 | (if (memq 'unresolved byte-compile-warnings) |
1036 | (let ((byte-compile-current-form "the end of the data")) | |
1037 | (if (cdr byte-compile-unresolved-functions) | |
1038 | (let* ((str "The following functions are not known to be defined: ") | |
1039 | (L (length str)) | |
1040 | (rest (reverse byte-compile-unresolved-functions)) | |
1041 | s) | |
1042 | (while rest | |
1043 | (setq s (symbol-name (car (car rest))) | |
1044 | L (+ L (length s) 2) | |
1045 | rest (cdr rest)) | |
1046 | (if (< L (1- fill-column)) | |
1047 | (setq str (concat str " " s (and rest ","))) | |
1048 | (setq str (concat str "\n " s (and rest ",")) | |
1049 | L (+ (length s) 4)))) | |
1050 | (byte-compile-warn "%s" str)) | |
1051 | (if byte-compile-unresolved-functions | |
1052 | (byte-compile-warn "the function %s is not known to be defined." | |
1053 | (car (car byte-compile-unresolved-functions))))))) | |
1054 | nil) | |
1055 | ||
1056 | \f | |
1057 | (defmacro byte-compile-constp (form) | |
1058 | ;; Returns non-nil if FORM is a constant. | |
1059 | (` (cond ((consp (, form)) (eq (car (, form)) 'quote)) | |
1060 | ((not (symbolp (, form)))) | |
1061 | ((memq (, form) '(nil t)))))) | |
1062 | ||
1063 | (defmacro byte-compile-close-variables (&rest body) | |
1064 | (cons 'let | |
1065 | (cons '(;; | |
1066 | ;; Close over these variables to encapsulate the | |
1067 | ;; compilation state | |
1068 | ;; | |
1069 | (byte-compile-macro-environment | |
1070 | ;; Copy it because the compiler may patch into the | |
1071 | ;; macroenvironment. | |
1072 | (copy-alist byte-compile-initial-macro-environment)) | |
1073 | (byte-compile-function-environment nil) | |
1074 | (byte-compile-bound-variables nil) | |
1075 | (byte-compile-free-references nil) | |
1076 | (byte-compile-free-assignments nil) | |
1077 | ;; | |
1078 | ;; Close over these variables so that `byte-compiler-options' | |
1079 | ;; can change them on a per-file basis. | |
1080 | ;; | |
1081 | (byte-compile-verbose byte-compile-verbose) | |
1082 | (byte-optimize byte-optimize) | |
d82e848c RS |
1083 | (byte-compile-compatibility byte-compile-compatibility) |
1084 | (byte-compile-dynamic byte-compile-dynamic) | |
1085 | (byte-compile-dynamic-docstrings | |
1086 | byte-compile-dynamic-docstrings) | |
52799cb8 RS |
1087 | ;; (byte-compile-generate-emacs19-bytecodes |
1088 | ;; byte-compile-generate-emacs19-bytecodes) | |
1c393159 JB |
1089 | (byte-compile-warnings (if (eq byte-compile-warnings t) |
1090 | byte-compile-warning-types | |
1091 | byte-compile-warnings)) | |
1092 | ) | |
1093 | body))) | |
1094 | ||
144b2637 | 1095 | (defvar byte-compile-warnings-point-max nil) |
1c393159 JB |
1096 | (defmacro displaying-byte-compile-warnings (&rest body) |
1097 | (list 'let | |
144b2637 RS |
1098 | '((byte-compile-warnings-point-max byte-compile-warnings-point-max)) |
1099 | ;; Log the file name. | |
1100 | '(byte-compile-log-file) | |
1101 | ;; Record how much is logged now. | |
1102 | ;; We will display the log buffer if anything more is logged | |
1103 | ;; before the end of BODY. | |
1104 | '(or byte-compile-warnings-point-max | |
1105 | (save-excursion | |
1106 | (set-buffer (get-buffer-create "*Compile-Log*")) | |
1107 | (setq byte-compile-warnings-point-max (point-max)))) | |
0b030df7 JB |
1108 | (list 'unwind-protect |
1109 | (list 'condition-case 'error-info | |
1110 | (cons 'progn body) | |
1111 | '(error | |
1112 | (byte-compile-report-error error-info))) | |
1c393159 JB |
1113 | '(save-excursion |
1114 | ;; If there were compilation warnings, display them. | |
1115 | (set-buffer "*Compile-Log*") | |
1116 | (if (= byte-compile-warnings-point-max (point-max)) | |
1117 | nil | |
1118 | (select-window | |
1119 | (prog1 (selected-window) | |
1120 | (select-window (display-buffer (current-buffer))) | |
1121 | (goto-char byte-compile-warnings-point-max) | |
1122 | (recenter 1)))))))) | |
1123 | ||
1124 | \f | |
fd5285f3 | 1125 | ;;;###autoload |
9742dbc0 RS |
1126 | (defun byte-force-recompile (directory) |
1127 | "Recompile every `.el' file in DIRECTORY that already has a `.elc' file. | |
1128 | Files in subdirectories of DIRECTORY are processed also." | |
c0f43df5 | 1129 | (interactive "DByte force recompile (directory): ") |
9742dbc0 RS |
1130 | (byte-recompile-directory directory nil t)) |
1131 | ||
1132 | ;;;###autoload | |
1133 | (defun byte-recompile-directory (directory &optional arg force) | |
1c393159 JB |
1134 | "Recompile every `.el' file in DIRECTORY that needs recompilation. |
1135 | This is if a `.elc' file exists but is older than the `.el' file. | |
691e7e76 | 1136 | Files in subdirectories of DIRECTORY are processed also. |
1c393159 JB |
1137 | |
1138 | If the `.elc' file does not exist, normally the `.el' file is *not* compiled. | |
1139 | But a prefix argument (optional second arg) means ask user, | |
9e2b097b | 1140 | for each such `.el' file, whether to compile it. Prefix argument 0 means |
691e7e76 RS |
1141 | don't ask and compile the file anyway. |
1142 | ||
9742dbc0 RS |
1143 | A nonzero prefix argument also means ask about each subdirectory. |
1144 | ||
1145 | If the third argument FORCE is non-nil, | |
1146 | recompile every `.el' file that already has a `.elc' file." | |
1c393159 | 1147 | (interactive "DByte recompile directory: \nP") |
0dea0bbe RM |
1148 | (if arg |
1149 | (setq arg (prefix-numeric-value arg))) | |
e27c3564 JB |
1150 | (if noninteractive |
1151 | nil | |
1152 | (save-some-buffers) | |
ba901388 | 1153 | (force-mode-line-update)) |
9e2b097b JB |
1154 | (let ((directories (list (expand-file-name directory))) |
1155 | (file-count 0) | |
1156 | (dir-count 0) | |
1157 | last-dir) | |
1158 | (displaying-byte-compile-warnings | |
1159 | (while directories | |
1160 | (setq directory (car directories)) | |
e27c3564 | 1161 | (or noninteractive (message "Checking %s..." directory)) |
9e2b097b JB |
1162 | (let ((files (directory-files directory)) |
1163 | source dest) | |
1164 | (while files | |
1165 | (setq source (expand-file-name (car files) directory)) | |
1166 | (if (and (not (member (car files) '("." ".." "RCS" "CVS"))) | |
e9681c45 RS |
1167 | (file-directory-p source) |
1168 | (not (file-symlink-p source))) | |
9742dbc0 | 1169 | ;; This file is a subdirectory. Handle them differently. |
9e2b097b | 1170 | (if (or (null arg) |
0dea0bbe | 1171 | (eq 0 arg) |
9e2b097b JB |
1172 | (y-or-n-p (concat "Check " source "? "))) |
1173 | (setq directories | |
1174 | (nconc directories (list source)))) | |
9742dbc0 | 1175 | ;; It is an ordinary file. Decide whether to compile it. |
9e2b097b JB |
1176 | (if (and (string-match emacs-lisp-file-regexp source) |
1177 | (not (auto-save-file-name-p source)) | |
1178 | (setq dest (byte-compile-dest-file source)) | |
1179 | (if (file-exists-p dest) | |
9742dbc0 RS |
1180 | ;; File was already compiled. |
1181 | (or force (file-newer-than-file-p source dest)) | |
1182 | ;; No compiled file exists yet. | |
9e2b097b | 1183 | (and arg |
0dea0bbe | 1184 | (or (eq 0 arg) |
9e2b097b | 1185 | (y-or-n-p (concat "Compile " source "? ")))))) |
e27c3564 JB |
1186 | (progn (if (and noninteractive (not byte-compile-verbose)) |
1187 | (message "Compiling %s..." source)) | |
1188 | (byte-compile-file source) | |
47082fcd RS |
1189 | (or noninteractive |
1190 | (message "Checking %s..." directory)) | |
9e2b097b JB |
1191 | (setq file-count (1+ file-count)) |
1192 | (if (not (eq last-dir directory)) | |
1193 | (setq last-dir directory | |
1194 | dir-count (1+ dir-count))) | |
1195 | ))) | |
1196 | (setq files (cdr files)))) | |
1197 | (setq directories (cdr directories)))) | |
1198 | (message "Done (Total of %d file%s compiled%s)" | |
1199 | file-count (if (= file-count 1) "" "s") | |
1200 | (if (> dir-count 1) (format " in %d directories" dir-count) "")))) | |
1c393159 | 1201 | |
fd5285f3 | 1202 | ;;;###autoload |
1c393159 JB |
1203 | (defun byte-compile-file (filename &optional load) |
1204 | "Compile a file of Lisp code named FILENAME into a file of byte code. | |
1205 | The output file's name is made by appending `c' to the end of FILENAME. | |
1c57117e RS |
1206 | With prefix arg (noninteractively: 2nd arg), load the file after compiling. |
1207 | The value is t if there were no errors, nil if errors." | |
1c393159 JB |
1208 | ;; (interactive "fByte compile file: \nP") |
1209 | (interactive | |
1210 | (let ((file buffer-file-name) | |
1211 | (file-name nil) | |
1212 | (file-dir nil)) | |
1213 | (and file | |
1214 | (eq (cdr (assq 'major-mode (buffer-local-variables))) | |
1215 | 'emacs-lisp-mode) | |
1216 | (setq file-name (file-name-nondirectory file) | |
1217 | file-dir (file-name-directory file))) | |
52799cb8 RS |
1218 | (list (read-file-name (if current-prefix-arg |
1219 | "Byte compile and load file: " | |
1220 | "Byte compile file: ") | |
79c6071d | 1221 | file-dir file-name nil) |
fd5285f3 | 1222 | current-prefix-arg))) |
1c393159 JB |
1223 | ;; Expand now so we get the current buffer's defaults |
1224 | (setq filename (expand-file-name filename)) | |
1225 | ||
1226 | ;; If we're compiling a file that's in a buffer and is modified, offer | |
1227 | ;; to save it first. | |
1228 | (or noninteractive | |
1229 | (let ((b (get-file-buffer (expand-file-name filename)))) | |
1230 | (if (and b (buffer-modified-p b) | |
1231 | (y-or-n-p (format "save buffer %s first? " (buffer-name b)))) | |
1232 | (save-excursion (set-buffer b) (save-buffer))))) | |
1233 | ||
1234 | (if byte-compile-verbose | |
1235 | (message "Compiling %s..." filename)) | |
3ea1f391 | 1236 | (let ((byte-compile-current-file filename) |
d82e848c RS |
1237 | target-file input-buffer output-buffer |
1238 | byte-compile-dest-file) | |
1239 | (setq target-file (byte-compile-dest-file filename)) | |
1240 | (setq byte-compile-dest-file target-file) | |
1c393159 | 1241 | (save-excursion |
ab94e6e7 RS |
1242 | (setq input-buffer (get-buffer-create " *Compiler Input*")) |
1243 | (set-buffer input-buffer) | |
1c393159 JB |
1244 | (erase-buffer) |
1245 | (insert-file-contents filename) | |
1246 | ;; Run hooks including the uncompression hook. | |
1247 | ;; If they change the file name, then change it for the output also. | |
d82e848c | 1248 | (let ((buffer-file-name filename) |
a096f13f | 1249 | (default-major-mode 'emacs-lisp-mode) |
d82e848c RS |
1250 | (enable-local-eval nil)) |
1251 | (normal-mode) | |
cd891e68 RS |
1252 | (setq filename buffer-file-name)) |
1253 | ;; Set the default directory, in case an eval-when-compile uses it. | |
1254 | (setq default-directory (file-name-directory filename))) | |
ab94e6e7 RS |
1255 | (setq byte-compiler-error-flag nil) |
1256 | ;; It is important that input-buffer not be current at this call, | |
1257 | ;; so that the value of point set in input-buffer | |
1258 | ;; within byte-compile-from-buffer lingers in that buffer. | |
8a5dd086 | 1259 | (setq output-buffer (byte-compile-from-buffer input-buffer filename)) |
189db152 RS |
1260 | (if byte-compiler-error-flag |
1261 | nil | |
92beedc2 KH |
1262 | (if byte-compile-verbose |
1263 | (message "Compiling %s...done" filename)) | |
189db152 RS |
1264 | (kill-buffer input-buffer) |
1265 | (save-excursion | |
1266 | (set-buffer output-buffer) | |
1267 | (goto-char (point-max)) | |
1268 | (insert "\n") ; aaah, unix. | |
1269 | (let ((vms-stmlf-recfm t)) | |
189db152 | 1270 | (if (file-writable-p target-file) |
b8575ac3 | 1271 | ;; We must disable any code conversion here. |
95aeae46 | 1272 | (let ((coding-system-for-write 'no-conversion)) |
2cd0169d | 1273 | (if (or (eq system-type 'ms-dos) (eq system-type 'windows-nt)) |
e3c72369 | 1274 | (setq buffer-file-type t)) |
189db152 RS |
1275 | (write-region 1 (point-max) target-file)) |
1276 | ;; This is just to give a better error message than | |
1277 | ;; write-region | |
1278 | (signal 'file-error | |
1279 | (list "Opening output file" | |
1280 | (if (file-exists-p target-file) | |
1281 | "cannot overwrite file" | |
1282 | "directory not writable or nonexistent") | |
d82e848c | 1283 | target-file)))) |
189db152 RS |
1284 | (kill-buffer (current-buffer))) |
1285 | (if (and byte-compile-generate-call-tree | |
1286 | (or (eq t byte-compile-generate-call-tree) | |
1287 | (y-or-n-p (format "Report call tree for %s? " filename)))) | |
1288 | (save-excursion | |
1289 | (display-call-tree filename))) | |
1290 | (if load | |
a2bb8f73 KH |
1291 | (load target-file)) |
1292 | t))) | |
1c393159 | 1293 | |
52799cb8 RS |
1294 | ;;(defun byte-compile-and-load-file (&optional filename) |
1295 | ;; "Compile a file of Lisp code named FILENAME into a file of byte code, | |
1296 | ;;and then load it. The output file's name is made by appending \"c\" to | |
1297 | ;;the end of FILENAME." | |
1298 | ;; (interactive) | |
1299 | ;; (if filename ; I don't get it, (interactive-p) doesn't always work | |
1300 | ;; (byte-compile-file filename t) | |
1301 | ;; (let ((current-prefix-arg '(4))) | |
1302 | ;; (call-interactively 'byte-compile-file)))) | |
1303 | ||
1304 | ;;(defun byte-compile-buffer (&optional buffer) | |
1305 | ;; "Byte-compile and evaluate contents of BUFFER (default: the current buffer)." | |
1306 | ;; (interactive "bByte compile buffer: ") | |
1307 | ;; (setq buffer (if buffer (get-buffer buffer) (current-buffer))) | |
1308 | ;; (message "Compiling %s..." (buffer-name buffer)) | |
1309 | ;; (let* ((filename (or (buffer-file-name buffer) | |
1310 | ;; (concat "#<buffer " (buffer-name buffer) ">"))) | |
1311 | ;; (byte-compile-current-file buffer)) | |
8a5dd086 | 1312 | ;; (byte-compile-from-buffer buffer nil)) |
52799cb8 RS |
1313 | ;; (message "Compiling %s...done" (buffer-name buffer)) |
1314 | ;; t) | |
1c393159 JB |
1315 | |
1316 | ;;; compiling a single function | |
fd5285f3 | 1317 | ;;;###autoload |
52799cb8 | 1318 | (defun compile-defun (&optional arg) |
1c393159 JB |
1319 | "Compile and evaluate the current top-level form. |
1320 | Print the result in the minibuffer. | |
1321 | With argument, insert value in current buffer after the form." | |
1322 | (interactive "P") | |
1323 | (save-excursion | |
1324 | (end-of-defun) | |
1325 | (beginning-of-defun) | |
1326 | (let* ((byte-compile-current-file nil) | |
1327 | (byte-compile-last-warned-form 'nothing) | |
fd5285f3 RS |
1328 | (value (eval (displaying-byte-compile-warnings |
1329 | (byte-compile-sexp (read (current-buffer))))))) | |
1c393159 JB |
1330 | (cond (arg |
1331 | (message "Compiling from buffer... done.") | |
1332 | (prin1 value (current-buffer)) | |
1333 | (insert "\n")) | |
1334 | ((message "%s" (prin1-to-string value))))))) | |
1335 | ||
1336 | ||
8a5dd086 RS |
1337 | (defun byte-compile-from-buffer (inbuffer &optional filename) |
1338 | ;; Filename is used for the loading-into-Emacs-18 error message. | |
d82e848c RS |
1339 | (let (outbuffer |
1340 | ;; Prevent truncation of flonums and lists as we read and print them | |
1341 | (float-output-format nil) | |
1342 | (case-fold-search nil) | |
1343 | (print-length nil) | |
95e7d933 | 1344 | (print-level nil) |
d82e848c RS |
1345 | ;; Simulate entry to byte-compile-top-level |
1346 | (byte-compile-constants nil) | |
1347 | (byte-compile-variables nil) | |
1348 | (byte-compile-tag-number 0) | |
1349 | (byte-compile-depth 0) | |
1350 | (byte-compile-maxdepth 0) | |
1351 | (byte-compile-output nil) | |
1352 | ;; #### This is bound in b-c-close-variables. | |
1353 | ;; (byte-compile-warnings (if (eq byte-compile-warnings t) | |
1354 | ;; byte-compile-warning-types | |
1355 | ;; byte-compile-warnings)) | |
1356 | ) | |
1357 | (byte-compile-close-variables | |
1358 | (save-excursion | |
1359 | (setq outbuffer | |
1360 | (set-buffer (get-buffer-create " *Compiler Output*"))) | |
1361 | (erase-buffer) | |
1362 | ;; (emacs-lisp-mode) | |
1363 | (setq case-fold-search nil) | |
f1f32df9 | 1364 | (and filename (byte-compile-insert-header filename inbuffer outbuffer)) |
d82e848c RS |
1365 | |
1366 | ;; This is a kludge. Some operating systems (OS/2, DOS) need to | |
1367 | ;; write files containing binary information specially. | |
1368 | ;; Under most circumstances, such files will be in binary | |
1369 | ;; overwrite mode, so those OS's use that flag to guess how | |
1370 | ;; they should write their data. Advise them that .elc files | |
1371 | ;; need to be written carefully. | |
1372 | (setq overwrite-mode 'overwrite-mode-binary)) | |
1373 | (displaying-byte-compile-warnings | |
1374 | (save-excursion | |
1375 | (set-buffer inbuffer) | |
1376 | (goto-char 1) | |
1377 | ||
1378 | ;; Compile the forms from the input buffer. | |
1379 | (while (progn | |
1380 | (while (progn (skip-chars-forward " \t\n\^l") | |
1381 | (looking-at ";")) | |
1382 | (forward-line 1)) | |
1383 | (not (eobp))) | |
1384 | (byte-compile-file-form (read inbuffer))) | |
1385 | ||
1386 | ;; Compile pending forms at end of file. | |
1387 | (byte-compile-flush-pending) | |
1388 | (byte-compile-warn-about-unresolved-functions) | |
a7acbbe4 | 1389 | ;; Should we always do this? When calling multiple files, it |
d82e848c RS |
1390 | ;; would be useful to delay this warning until all have |
1391 | ;; been compiled. | |
1392 | (setq byte-compile-unresolved-functions nil)))) | |
285cdf4e | 1393 | outbuffer)) |
8a5dd086 | 1394 | |
f1f32df9 RS |
1395 | (defun byte-compile-insert-header (filename inbuffer outbuffer) |
1396 | (set-buffer inbuffer) | |
1e098504 RS |
1397 | (let ((dynamic-docstrings byte-compile-dynamic-docstrings) |
1398 | (dynamic byte-compile-dynamic)) | |
f1f32df9 RS |
1399 | (set-buffer outbuffer) |
1400 | (goto-char 1) | |
1401 | ;; | |
1402 | ;; The magic number of .elc files is ";ELC", or 0x3B454C43. After that is | |
1403 | ;; the file-format version number (18 or 19) as a byte, followed by some | |
1404 | ;; nulls. The primary motivation for doing this is to get some binary | |
1405 | ;; characters up in the first line of the file so that `diff' will simply | |
1406 | ;; say "Binary files differ" instead of actually doing a diff of two .elc | |
1407 | ;; files. An extra benefit is that you can add this to /etc/magic: | |
1408 | ;; | |
1409 | ;; 0 string ;ELC GNU Emacs Lisp compiled file, | |
1410 | ;; >4 byte x version %d | |
1411 | ;; | |
1412 | (insert | |
1413 | ";ELC" | |
1414 | (if (byte-compile-version-cond byte-compile-compatibility) 18 19) | |
1415 | "\000\000\000\n" | |
1416 | ) | |
1e098504 | 1417 | (insert ";;; Compiled by " |
f1f32df9 RS |
1418 | (or (and (boundp 'user-mail-address) user-mail-address) |
1419 | (concat (user-login-name) "@" (system-name))) | |
1420 | " on " | |
1421 | (current-time-string) "\n;;; from file " filename "\n") | |
1e098504 | 1422 | (insert ";;; in Emacs version " emacs-version "\n") |
5f17a95a | 1423 | (insert ";;; with bytecomp version " |
fd20f015 RS |
1424 | (progn (string-match "[0-9.]+" byte-compile-version) |
1425 | (match-string 0 byte-compile-version)) | |
5f17a95a | 1426 | "\n;;; " |
f1f32df9 | 1427 | (cond |
1e098504 RS |
1428 | ((eq byte-optimize 'source) "with source-level optimization only") |
1429 | ((eq byte-optimize 'byte) "with byte-level optimization only") | |
1430 | (byte-optimize "with all optimizations") | |
1431 | (t "without optimization")) | |
f1f32df9 RS |
1432 | (if (byte-compile-version-cond byte-compile-compatibility) |
1433 | "; compiled with Emacs 18 compatibility.\n" | |
1434 | ".\n")) | |
1e098504 RS |
1435 | (if dynamic |
1436 | (insert ";;; Function definitions are lazy-loaded.\n")) | |
f1f32df9 | 1437 | (if (not (byte-compile-version-cond byte-compile-compatibility)) |
1e098504 | 1438 | (insert ";;; This file uses opcodes which do not exist in Emacs 18.\n" |
f1f32df9 RS |
1439 | ;; Have to check if emacs-version is bound so that this works |
1440 | ;; in files loaded early in loadup.el. | |
1441 | "\n(if (and (boundp 'emacs-version)\n" | |
666ef008 RS |
1442 | ;; If there is a name at the end of emacs-version, |
1443 | ;; don't try to check the version number. | |
7bb250da KH |
1444 | "\t (< (aref emacs-version (1- (length emacs-version))) ?A)\n" |
1445 | "\t (or (and (boundp 'epoch::version) epoch::version)\n" | |
f1f32df9 RS |
1446 | (if dynamic-docstrings |
1447 | "\t (string-lessp emacs-version \"19.29\")))\n" | |
1448 | "\t (string-lessp emacs-version \"19\")))\n") | |
1449 | " (error \"`" | |
1450 | ;; prin1-to-string is used to quote backslashes. | |
1451 | (substring (prin1-to-string (file-name-nondirectory filename)) | |
1452 | 1 -1) | |
1453 | (if dynamic-docstrings | |
1454 | "' was compiled for Emacs 19.29 or later\"))\n\n" | |
1455 | "' was compiled for Emacs 19\"))\n\n")) | |
1456 | (insert "(or (boundp 'current-load-list) (setq current-load-list nil))\n" | |
1457 | "\n") | |
1458 | ))) | |
1c393159 JB |
1459 | |
1460 | ||
1461 | (defun byte-compile-output-file-form (form) | |
1462 | ;; writes the given form to the output buffer, being careful of docstrings | |
1463 | ;; in defun, defmacro, defvar, defconst and autoload because make-docfile is | |
1464 | ;; so amazingly stupid. | |
c36881cf ER |
1465 | ;; defalias calls are output directly by byte-compile-file-form-defmumble; |
1466 | ;; it does not pay to first build the defalias in defmumble and then parse | |
1467 | ;; it here. | |
1c393159 JB |
1468 | (if (and (memq (car-safe form) '(defun defmacro defvar defconst autoload)) |
1469 | (stringp (nth 3 form))) | |
d82e848c RS |
1470 | (byte-compile-output-docform nil nil '("\n(" 3 ")") form nil |
1471 | (eq (car form) 'autoload)) | |
1c393159 | 1472 | (let ((print-escape-newlines t) |
37c29340 KH |
1473 | (print-length nil) |
1474 | (print-level nil) | |
77308fd7 EN |
1475 | (print-quoted t) |
1476 | (print-gensym t)) | |
1c393159 JB |
1477 | (princ "\n" outbuffer) |
1478 | (prin1 form outbuffer) | |
1479 | nil))) | |
1480 | ||
d82e848c | 1481 | (defun byte-compile-output-docform (preface name info form specindex quoted) |
dac6f673 RS |
1482 | "Print a form with a doc string. INFO is (prefix doc-index postfix). |
1483 | If PREFACE and NAME are non-nil, print them too, | |
1484 | before INFO and the FORM but after the doc string itself. | |
1485 | If SPECINDEX is non-nil, it is the index in FORM | |
1486 | of the function bytecode string. In that case, | |
1487 | we output that argument and the following argument (the constants vector) | |
1488 | together, for lazy loading. | |
1489 | QUOTED says that we have to put a quote before the | |
1490 | list that represents a doc string reference. | |
1491 | `autoload' needs that." | |
1492 | ;; We need to examine byte-compile-dynamic-docstrings | |
1493 | ;; in the input buffer (now current), not in the output buffer. | |
1494 | (let ((dynamic-docstrings byte-compile-dynamic-docstrings)) | |
1495 | (set-buffer | |
1496 | (prog1 (current-buffer) | |
1497 | (set-buffer outbuffer) | |
1498 | (let (position) | |
1499 | ||
1500 | ;; Insert the doc string, and make it a comment with #@LENGTH. | |
1501 | (and (>= (nth 1 info) 0) | |
1502 | dynamic-docstrings | |
393ae6ec | 1503 | (not byte-compile-compatibility) |
dac6f673 RS |
1504 | (progn |
1505 | ;; Make the doc string start at beginning of line | |
1506 | ;; for make-docfile's sake. | |
1507 | (insert "\n") | |
1508 | (setq position | |
1509 | (byte-compile-output-as-comment | |
1510 | (nth (nth 1 info) form) nil)) | |
1511 | ;; If the doc string starts with * (a user variable), | |
1512 | ;; negate POSITION. | |
1513 | (if (and (stringp (nth (nth 1 info) form)) | |
1514 | (> (length (nth (nth 1 info) form)) 0) | |
1515 | (eq (aref (nth (nth 1 info) form) 0) ?*)) | |
1516 | (setq position (- position))))) | |
1517 | ||
1518 | (if preface | |
1519 | (progn | |
1520 | (insert preface) | |
1521 | (prin1 name outbuffer))) | |
1522 | (insert (car info)) | |
1523 | (let ((print-escape-newlines t) | |
77308fd7 | 1524 | (print-quoted t) |
b077f045 RS |
1525 | ;; Use a cons cell to say that we want |
1526 | ;; print-gensym-alist not to be cleared | |
1527 | ;; between calls to print functions. | |
1528 | (print-gensym '(t)) | |
1529 | print-gensym-alist | |
dac6f673 RS |
1530 | (index 0)) |
1531 | (prin1 (car form) outbuffer) | |
1532 | (while (setq form (cdr form)) | |
1533 | (setq index (1+ index)) | |
1534 | (insert " ") | |
1535 | (cond ((and (numberp specindex) (= index specindex)) | |
1536 | (let ((position | |
1537 | (byte-compile-output-as-comment | |
1538 | (cons (car form) (nth 1 form)) | |
1539 | t))) | |
1540 | (princ (format "(#$ . %d) nil" position) outbuffer) | |
1541 | (setq form (cdr form)) | |
1542 | (setq index (1+ index)))) | |
1543 | ((= index (nth 1 info)) | |
1544 | (if position | |
1545 | (princ (format (if quoted "'(#$ . %d)" "(#$ . %d)") | |
1546 | position) | |
1547 | outbuffer) | |
1548 | (let ((print-escape-newlines nil)) | |
1549 | (goto-char (prog1 (1+ (point)) | |
1550 | (prin1 (car form) outbuffer))) | |
1551 | (insert "\\\n") | |
1552 | (goto-char (point-max))))) | |
1553 | (t | |
1554 | (prin1 (car form) outbuffer))))) | |
1555 | (insert (nth 2 info)))))) | |
1c393159 JB |
1556 | nil) |
1557 | ||
1558 | (defun byte-compile-keep-pending (form &optional handler) | |
1559 | (if (memq byte-optimize '(t source)) | |
1560 | (setq form (byte-optimize-form form t))) | |
1561 | (if handler | |
1562 | (let ((for-effect t)) | |
1563 | ;; To avoid consing up monstrously large forms at load time, we split | |
1564 | ;; the output regularly. | |
b4ff4a23 RS |
1565 | (and (memq (car-safe form) '(fset defalias)) |
1566 | (nthcdr 300 byte-compile-output) | |
1c393159 JB |
1567 | (byte-compile-flush-pending)) |
1568 | (funcall handler form) | |
1569 | (if for-effect | |
1570 | (byte-compile-discard))) | |
1571 | (byte-compile-form form t)) | |
1572 | nil) | |
1573 | ||
1574 | (defun byte-compile-flush-pending () | |
1575 | (if byte-compile-output | |
1576 | (let ((form (byte-compile-out-toplevel t 'file))) | |
1577 | (cond ((eq (car-safe form) 'progn) | |
1578 | (mapcar 'byte-compile-output-file-form (cdr form))) | |
1579 | (form | |
1580 | (byte-compile-output-file-form form))) | |
1581 | (setq byte-compile-constants nil | |
1582 | byte-compile-variables nil | |
1583 | byte-compile-depth 0 | |
1584 | byte-compile-maxdepth 0 | |
1585 | byte-compile-output nil)))) | |
1586 | ||
1587 | (defun byte-compile-file-form (form) | |
1588 | (let ((byte-compile-current-form nil) ; close over this for warnings. | |
1589 | handler) | |
1590 | (cond | |
1591 | ((not (consp form)) | |
1592 | (byte-compile-keep-pending form)) | |
1593 | ((and (symbolp (car form)) | |
1594 | (setq handler (get (car form) 'byte-hunk-handler))) | |
1595 | (cond ((setq form (funcall handler form)) | |
1596 | (byte-compile-flush-pending) | |
1597 | (byte-compile-output-file-form form)))) | |
1598 | ((eq form (setq form (macroexpand form byte-compile-macro-environment))) | |
1599 | (byte-compile-keep-pending form)) | |
1600 | (t | |
1601 | (byte-compile-file-form form))))) | |
1602 | ||
1603 | ;; Functions and variables with doc strings must be output separately, | |
1604 | ;; so make-docfile can recognise them. Most other things can be output | |
1605 | ;; as byte-code. | |
1606 | ||
1607 | (put 'defsubst 'byte-hunk-handler 'byte-compile-file-form-defsubst) | |
1608 | (defun byte-compile-file-form-defsubst (form) | |
1609 | (cond ((assq (nth 1 form) byte-compile-unresolved-functions) | |
1610 | (setq byte-compile-current-form (nth 1 form)) | |
1611 | (byte-compile-warn "defsubst %s was used before it was defined" | |
1612 | (nth 1 form)))) | |
1613 | (byte-compile-file-form | |
1614 | (macroexpand form byte-compile-macro-environment)) | |
1615 | ;; Return nil so the form is not output twice. | |
1616 | nil) | |
1617 | ||
1618 | (put 'autoload 'byte-hunk-handler 'byte-compile-file-form-autoload) | |
1619 | (defun byte-compile-file-form-autoload (form) | |
1620 | (and (let ((form form)) | |
1621 | (while (if (setq form (cdr form)) (byte-compile-constp (car form)))) | |
1622 | (null form)) ;Constants only | |
1623 | (eval (nth 5 form)) ;Macro | |
1624 | (eval form)) ;Define the autoload. | |
1625 | (if (stringp (nth 3 form)) | |
1626 | form | |
1627 | ;; No doc string, so we can compile this as a normal form. | |
1628 | (byte-compile-keep-pending form 'byte-compile-normal-call))) | |
1629 | ||
1630 | (put 'defvar 'byte-hunk-handler 'byte-compile-file-form-defvar) | |
1631 | (put 'defconst 'byte-hunk-handler 'byte-compile-file-form-defvar) | |
1632 | (defun byte-compile-file-form-defvar (form) | |
1633 | (if (null (nth 3 form)) | |
1634 | ;; Since there is no doc string, we can compile this as a normal form, | |
1635 | ;; and not do a file-boundary. | |
1636 | (byte-compile-keep-pending form) | |
1637 | (if (memq 'free-vars byte-compile-warnings) | |
1638 | (setq byte-compile-bound-variables | |
1639 | (cons (nth 1 form) byte-compile-bound-variables))) | |
1640 | (cond ((consp (nth 2 form)) | |
1641 | (setq form (copy-sequence form)) | |
1642 | (setcar (cdr (cdr form)) | |
1643 | (byte-compile-top-level (nth 2 form) nil 'file)))) | |
1644 | form)) | |
1645 | ||
8c731d3d RS |
1646 | (put 'custom-declare-variable 'byte-hunk-handler |
1647 | 'byte-compile-file-form-custom-declare-variable) | |
1648 | (defun byte-compile-file-form-custom-declare-variable (form) | |
1649 | (if (memq 'free-vars byte-compile-warnings) | |
1650 | (setq byte-compile-bound-variables | |
1651 | (cons (nth 1 (nth 1 form)) byte-compile-bound-variables))) | |
1652 | form) | |
1653 | ||
1c393159 JB |
1654 | (put 'require 'byte-hunk-handler 'byte-compile-file-form-eval-boundary) |
1655 | (defun byte-compile-file-form-eval-boundary (form) | |
1656 | (eval form) | |
1657 | (byte-compile-keep-pending form 'byte-compile-normal-call)) | |
1658 | ||
1659 | (put 'progn 'byte-hunk-handler 'byte-compile-file-form-progn) | |
1660 | (put 'prog1 'byte-hunk-handler 'byte-compile-file-form-progn) | |
1661 | (put 'prog2 'byte-hunk-handler 'byte-compile-file-form-progn) | |
1662 | (defun byte-compile-file-form-progn (form) | |
1663 | (mapcar 'byte-compile-file-form (cdr form)) | |
1664 | ;; Return nil so the forms are not output twice. | |
1665 | nil) | |
1666 | ||
1667 | ;; This handler is not necessary, but it makes the output from dont-compile | |
1668 | ;; and similar macros cleaner. | |
1669 | (put 'eval 'byte-hunk-handler 'byte-compile-file-form-eval) | |
1670 | (defun byte-compile-file-form-eval (form) | |
1671 | (if (eq (car-safe (nth 1 form)) 'quote) | |
1672 | (nth 1 (nth 1 form)) | |
1673 | (byte-compile-keep-pending form))) | |
1674 | ||
1675 | (put 'defun 'byte-hunk-handler 'byte-compile-file-form-defun) | |
1676 | (defun byte-compile-file-form-defun (form) | |
1677 | (byte-compile-file-form-defmumble form nil)) | |
1678 | ||
1679 | (put 'defmacro 'byte-hunk-handler 'byte-compile-file-form-defmacro) | |
1680 | (defun byte-compile-file-form-defmacro (form) | |
1681 | (byte-compile-file-form-defmumble form t)) | |
1682 | ||
1683 | (defun byte-compile-file-form-defmumble (form macrop) | |
1684 | (let* ((name (car (cdr form))) | |
1685 | (this-kind (if macrop 'byte-compile-macro-environment | |
1686 | 'byte-compile-function-environment)) | |
1687 | (that-kind (if macrop 'byte-compile-function-environment | |
1688 | 'byte-compile-macro-environment)) | |
1689 | (this-one (assq name (symbol-value this-kind))) | |
1690 | (that-one (assq name (symbol-value that-kind))) | |
1691 | (byte-compile-free-references nil) | |
1692 | (byte-compile-free-assignments nil)) | |
1693 | ||
1694 | ;; When a function or macro is defined, add it to the call tree so that | |
1695 | ;; we can tell when functions are not used. | |
1696 | (if byte-compile-generate-call-tree | |
1697 | (or (assq name byte-compile-call-tree) | |
1698 | (setq byte-compile-call-tree | |
1699 | (cons (list name nil nil) byte-compile-call-tree)))) | |
1700 | ||
1701 | (setq byte-compile-current-form name) ; for warnings | |
1702 | (if (memq 'redefine byte-compile-warnings) | |
1703 | (byte-compile-arglist-warn form macrop)) | |
1704 | (if byte-compile-verbose | |
47cf9d3a | 1705 | (message "Compiling %s... (%s)" (or filename "") (nth 1 form))) |
1c393159 JB |
1706 | (cond (that-one |
1707 | (if (and (memq 'redefine byte-compile-warnings) | |
52799cb8 | 1708 | ;; don't warn when compiling the stubs in byte-run... |
1c393159 JB |
1709 | (not (assq (nth 1 form) |
1710 | byte-compile-initial-macro-environment))) | |
1711 | (byte-compile-warn | |
1712 | "%s defined multiple times, as both function and macro" | |
1713 | (nth 1 form))) | |
1714 | (setcdr that-one nil)) | |
1715 | (this-one | |
1716 | (if (and (memq 'redefine byte-compile-warnings) | |
1717 | ;; hack: don't warn when compiling the magic internal | |
52799cb8 | 1718 | ;; byte-compiler macros in byte-run.el... |
1c393159 JB |
1719 | (not (assq (nth 1 form) |
1720 | byte-compile-initial-macro-environment))) | |
1721 | (byte-compile-warn "%s %s defined multiple times in this file" | |
1722 | (if macrop "macro" "function") | |
1723 | (nth 1 form)))) | |
1724 | ((and (fboundp name) | |
1725 | (eq (car-safe (symbol-function name)) | |
1726 | (if macrop 'lambda 'macro))) | |
1727 | (if (memq 'redefine byte-compile-warnings) | |
1728 | (byte-compile-warn "%s %s being redefined as a %s" | |
1729 | (if macrop "function" "macro") | |
1730 | (nth 1 form) | |
1731 | (if macrop "macro" "function"))) | |
1732 | ;; shadow existing definition | |
1733 | (set this-kind | |
1734 | (cons (cons name nil) (symbol-value this-kind)))) | |
1735 | ) | |
1736 | (let ((body (nthcdr 3 form))) | |
1737 | (if (and (stringp (car body)) | |
1738 | (symbolp (car-safe (cdr-safe body))) | |
1739 | (car-safe (cdr-safe body)) | |
1740 | (stringp (car-safe (cdr-safe (cdr-safe body))))) | |
1741 | (byte-compile-warn "Probable `\"' without `\\' in doc string of %s" | |
1742 | (nth 1 form)))) | |
1743 | (let* ((new-one (byte-compile-lambda (cons 'lambda (nthcdr 2 form)))) | |
1744 | (code (byte-compile-byte-code-maker new-one))) | |
1745 | (if this-one | |
1746 | (setcdr this-one new-one) | |
1747 | (set this-kind | |
1748 | (cons (cons name new-one) (symbol-value this-kind)))) | |
1749 | (if (and (stringp (nth 3 form)) | |
1750 | (eq 'quote (car-safe code)) | |
1751 | (eq 'lambda (car-safe (nth 1 code)))) | |
1752 | (cons (car form) | |
1753 | (cons name (cdr (nth 1 code)))) | |
d82e848c | 1754 | (byte-compile-flush-pending) |
1c393159 | 1755 | (if (not (stringp (nth 3 form))) |
d82e848c RS |
1756 | ;; No doc string. Provide -1 as the "doc string index" |
1757 | ;; so that no element will be treated as a doc string. | |
1758 | (byte-compile-output-docform | |
1759 | (if (byte-compile-version-cond byte-compile-compatibility) | |
1760 | "\n(fset '" "\n(defalias '") | |
1761 | name | |
1762 | (cond ((atom code) | |
1763 | (if macrop '(" '(macro . #[" -1 "])") '(" #[" -1 "]"))) | |
1764 | ((eq (car code) 'quote) | |
1765 | (setq code new-one) | |
1766 | (if macrop '(" '(macro " -1 ")") '(" '(" -1 ")"))) | |
1767 | ((if macrop '(" (cons 'macro (" -1 "))") '(" (" -1 ")")))) | |
1768 | (append code nil) | |
1769 | (and (atom code) byte-compile-dynamic | |
1770 | 1) | |
1771 | nil) | |
1c393159 | 1772 | ;; Output the form by hand, that's much simpler than having |
c36881cf | 1773 | ;; b-c-output-file-form analyze the defalias. |
1c393159 | 1774 | (byte-compile-output-docform |
d82e848c RS |
1775 | (if (byte-compile-version-cond byte-compile-compatibility) |
1776 | "\n(fset '" "\n(defalias '") | |
1777 | name | |
1c393159 JB |
1778 | (cond ((atom code) |
1779 | (if macrop '(" '(macro . #[" 4 "])") '(" #[" 4 "]"))) | |
1780 | ((eq (car code) 'quote) | |
1781 | (setq code new-one) | |
1782 | (if macrop '(" '(macro " 2 ")") '(" '(" 2 ")"))) | |
1783 | ((if macrop '(" (cons 'macro (" 5 "))") '(" (" 5 ")")))) | |
d82e848c RS |
1784 | (append code nil) |
1785 | (and (atom code) byte-compile-dynamic | |
1786 | 1) | |
1787 | nil)) | |
1788 | (princ ")" outbuffer) | |
1789 | nil)))) | |
1790 | ||
1791 | ;; Print Lisp object EXP in the output file, inside a comment, | |
1792 | ;; and return the file position it will have. | |
1793 | ;; If QUOTED is non-nil, print with quoting; otherwise, print without quoting. | |
1794 | (defun byte-compile-output-as-comment (exp quoted) | |
1795 | (let ((position (point))) | |
1796 | (set-buffer | |
1797 | (prog1 (current-buffer) | |
1798 | (set-buffer outbuffer) | |
1799 | ||
1800 | ;; Insert EXP, and make it a comment with #@LENGTH. | |
1801 | (insert " ") | |
1802 | (if quoted | |
1803 | (prin1 exp outbuffer) | |
1804 | (princ exp outbuffer)) | |
1805 | (goto-char position) | |
1806 | ;; Quote certain special characters as needed. | |
1807 | ;; get_doc_string in doc.c does the unquoting. | |
1808 | (while (search-forward "\^A" nil t) | |
1809 | (replace-match "\^A\^A" t t)) | |
1810 | (goto-char position) | |
1811 | (while (search-forward "\000" nil t) | |
1812 | (replace-match "\^A0" t t)) | |
1813 | (goto-char position) | |
1814 | (while (search-forward "\037" nil t) | |
1815 | (replace-match "\^A_" t t)) | |
1816 | (goto-char (point-max)) | |
1817 | (insert "\037") | |
1818 | (goto-char position) | |
1819 | (insert "#@" (format "%d" (- (point-max) position))) | |
1820 | ||
1821 | ;; Save the file position of the object. | |
1822 | ;; Note we should add 1 to skip the space | |
1823 | ;; that we inserted before the actual doc string, | |
1824 | ;; and subtract 1 to convert from an 1-origin Emacs position | |
1825 | ;; to a file position; they cancel. | |
1826 | (setq position (point)) | |
1827 | (goto-char (point-max)))) | |
1828 | position)) | |
1829 | ||
1c393159 JB |
1830 | |
1831 | \f | |
fd5285f3 | 1832 | ;;;###autoload |
1c393159 JB |
1833 | (defun byte-compile (form) |
1834 | "If FORM is a symbol, byte-compile its function definition. | |
1835 | If FORM is a lambda or a macro, byte-compile it as a function." | |
1836 | (displaying-byte-compile-warnings | |
1837 | (byte-compile-close-variables | |
1838 | (let* ((fun (if (symbolp form) | |
1839 | (and (fboundp form) (symbol-function form)) | |
1840 | form)) | |
1841 | (macro (eq (car-safe fun) 'macro))) | |
1842 | (if macro | |
1843 | (setq fun (cdr fun))) | |
1844 | (cond ((eq (car-safe fun) 'lambda) | |
1845 | (setq fun (if macro | |
1846 | (cons 'macro (byte-compile-lambda fun)) | |
1847 | (byte-compile-lambda fun))) | |
1848 | (if (symbolp form) | |
c36881cf | 1849 | (defalias form fun) |
1c393159 JB |
1850 | fun))))))) |
1851 | ||
1852 | (defun byte-compile-sexp (sexp) | |
1853 | "Compile and return SEXP." | |
1854 | (displaying-byte-compile-warnings | |
1855 | (byte-compile-close-variables | |
1856 | (byte-compile-top-level sexp)))) | |
1857 | ||
1858 | ;; Given a function made by byte-compile-lambda, make a form which produces it. | |
1859 | (defun byte-compile-byte-code-maker (fun) | |
1860 | (cond | |
52799cb8 | 1861 | ((byte-compile-version-cond byte-compile-compatibility) |
1c393159 JB |
1862 | ;; Return (quote (lambda ...)). |
1863 | (list 'quote (byte-compile-byte-code-unmake fun))) | |
1864 | ;; ## atom is faster than compiled-func-p. | |
1865 | ((atom fun) ; compiled function. | |
1866 | ;; generate-emacs19-bytecodes must be on, otherwise byte-compile-lambda | |
1867 | ;; would have produced a lambda. | |
469414a0 | 1868 | fun) |
1c393159 | 1869 | ;; b-c-lambda didn't produce a compiled-function, so it's either a trivial |
52799cb8 | 1870 | ;; function, or this is Emacs 18, or generate-emacs19-bytecodes is off. |
1c393159 JB |
1871 | ((let (tmp) |
1872 | (if (and (setq tmp (assq 'byte-code (cdr-safe (cdr fun)))) | |
1873 | (null (cdr (memq tmp fun)))) | |
1874 | ;; Generate a make-byte-code call. | |
1875 | (let* ((interactive (assq 'interactive (cdr (cdr fun))))) | |
1876 | (nconc (list 'make-byte-code | |
1877 | (list 'quote (nth 1 fun)) ;arglist | |
1878 | (nth 1 tmp) ;bytes | |
1879 | (nth 2 tmp) ;consts | |
1880 | (nth 3 tmp)) ;depth | |
1881 | (cond ((stringp (nth 2 fun)) | |
1882 | (list (nth 2 fun))) ;doc | |
1883 | (interactive | |
1884 | (list nil))) | |
1885 | (cond (interactive | |
1886 | (list (if (or (null (nth 1 interactive)) | |
1887 | (stringp (nth 1 interactive))) | |
1888 | (nth 1 interactive) | |
1889 | ;; Interactive spec is a list or a variable | |
1890 | ;; (if it is correct). | |
1891 | (list 'quote (nth 1 interactive)))))))) | |
1892 | ;; a non-compiled function (probably trivial) | |
1893 | (list 'quote fun)))))) | |
1894 | ||
1895 | ;; Turn a function into an ordinary lambda. Needed for v18 files. | |
1896 | (defun byte-compile-byte-code-unmake (function) | |
1897 | (if (consp function) | |
1898 | function;;It already is a lambda. | |
1899 | (setq function (append function nil)) ; turn it into a list | |
1900 | (nconc (list 'lambda (nth 0 function)) | |
1901 | (and (nth 4 function) (list (nth 4 function))) | |
1902 | (if (nthcdr 5 function) | |
1903 | (list (cons 'interactive (if (nth 5 function) | |
1904 | (nthcdr 5 function))))) | |
1905 | (list (list 'byte-code | |
1906 | (nth 1 function) (nth 2 function) | |
1907 | (nth 3 function)))))) | |
1908 | ||
1909 | ||
1910 | ;; Byte-compile a lambda-expression and return a valid function. | |
1911 | ;; The value is usually a compiled function but may be the original | |
1912 | ;; lambda-expression. | |
1913 | (defun byte-compile-lambda (fun) | |
1914 | (let* ((arglist (nth 1 fun)) | |
1915 | (byte-compile-bound-variables | |
1916 | (nconc (and (memq 'free-vars byte-compile-warnings) | |
1917 | (delq '&rest (delq '&optional (copy-sequence arglist)))) | |
1918 | byte-compile-bound-variables)) | |
1919 | (body (cdr (cdr fun))) | |
1920 | (doc (if (stringp (car body)) | |
1921 | (prog1 (car body) | |
d8f59f56 RS |
1922 | ;; Discard the doc string |
1923 | ;; unless it is the last element of the body. | |
1924 | (if (nthcdr 2 body) | |
1925 | (setq body (cdr body)))))) | |
1c393159 JB |
1926 | (int (assq 'interactive body))) |
1927 | (cond (int | |
1928 | ;; Skip (interactive) if it is in front (the most usual location). | |
1929 | (if (eq int (car body)) | |
1930 | (setq body (cdr body))) | |
ffc394dd | 1931 | (cond ((consp (cdr int)) |
1c393159 JB |
1932 | (if (cdr (cdr int)) |
1933 | (byte-compile-warn "malformed interactive spec: %s" | |
1934 | (prin1-to-string int))) | |
ffc394dd RS |
1935 | ;; If the interactive spec is a call to `list', |
1936 | ;; don't compile it, because `call-interactively' | |
1937 | ;; looks at the args of `list'. | |
c0f43df5 RS |
1938 | (let ((form (nth 1 int))) |
1939 | (while (or (eq (car-safe form) 'let) | |
1940 | (eq (car-safe form) 'let*) | |
1941 | (eq (car-safe form) 'save-excursion)) | |
1942 | (while (consp (cdr form)) | |
1943 | (setq form (cdr form))) | |
1944 | (setq form (car form))) | |
1945 | (or (eq (car-safe form) 'list) | |
1946 | (setq int (list 'interactive | |
1947 | (byte-compile-top-level (nth 1 int))))))) | |
ffc394dd RS |
1948 | ((cdr int) |
1949 | (byte-compile-warn "malformed interactive spec: %s" | |
1950 | (prin1-to-string int)))))) | |
1c393159 JB |
1951 | (let ((compiled (byte-compile-top-level (cons 'progn body) nil 'lambda))) |
1952 | (if (and (eq 'byte-code (car-safe compiled)) | |
b890df1a RS |
1953 | (not (byte-compile-version-cond |
1954 | byte-compile-compatibility))) | |
1c393159 JB |
1955 | (apply 'make-byte-code |
1956 | (append (list arglist) | |
1957 | ;; byte-string, constants-vector, stack depth | |
1958 | (cdr compiled) | |
1959 | ;; optionally, the doc string. | |
1960 | (if (or doc int) | |
1961 | (list doc)) | |
1962 | ;; optionally, the interactive spec. | |
1963 | (if int | |
1964 | (list (nth 1 int))))) | |
1965 | (setq compiled | |
1966 | (nconc (if int (list int)) | |
1967 | (cond ((eq (car-safe compiled) 'progn) (cdr compiled)) | |
1968 | (compiled (list compiled))))) | |
1969 | (nconc (list 'lambda arglist) | |
1970 | (if (or doc (stringp (car compiled))) | |
1971 | (cons doc (cond (compiled) | |
1972 | (body (list nil)))) | |
1973 | compiled)))))) | |
1974 | ||
1975 | (defun byte-compile-constants-vector () | |
1976 | ;; Builds the constants-vector from the current variables and constants. | |
1977 | ;; This modifies the constants from (const . nil) to (const . offset). | |
1978 | ;; To keep the byte-codes to look up the vector as short as possible: | |
1979 | ;; First 6 elements are vars, as there are one-byte varref codes for those. | |
1980 | ;; Next up to byte-constant-limit are constants, still with one-byte codes. | |
1981 | ;; Next variables again, to get 2-byte codes for variable lookup. | |
1982 | ;; The rest of the constants and variables need 3-byte byte-codes. | |
1983 | (let* ((i -1) | |
1984 | (rest (nreverse byte-compile-variables)) ; nreverse because the first | |
1985 | (other (nreverse byte-compile-constants)) ; vars often are used most. | |
1986 | ret tmp | |
1987 | (limits '(5 ; Use the 1-byte varref codes, | |
1988 | 63 ; 1-constlim ; 1-byte byte-constant codes, | |
1989 | 255 ; 2-byte varref codes, | |
1990 | 65535)) ; 3-byte codes for the rest. | |
1991 | limit) | |
1992 | (while (or rest other) | |
1993 | (setq limit (car limits)) | |
1994 | (while (and rest (not (eq i limit))) | |
1995 | (if (setq tmp (assq (car (car rest)) ret)) | |
1996 | (setcdr (car rest) (cdr tmp)) | |
1997 | (setcdr (car rest) (setq i (1+ i))) | |
1998 | (setq ret (cons (car rest) ret))) | |
1999 | (setq rest (cdr rest))) | |
2000 | (setq limits (cdr limits) | |
2001 | rest (prog1 other | |
2002 | (setq other rest)))) | |
2003 | (apply 'vector (nreverse (mapcar 'car ret))))) | |
2004 | ||
2005 | ;; Given an expression FORM, compile it and return an equivalent byte-code | |
2006 | ;; expression (a call to the function byte-code). | |
2007 | (defun byte-compile-top-level (form &optional for-effect output-type) | |
2008 | ;; OUTPUT-TYPE advises about how form is expected to be used: | |
2009 | ;; 'eval or nil -> a single form, | |
2010 | ;; 'progn or t -> a list of forms, | |
2011 | ;; 'lambda -> body of a lambda, | |
2012 | ;; 'file -> used at file-level. | |
285cdf4e RS |
2013 | (let ((byte-compile-constants nil) |
2014 | (byte-compile-variables nil) | |
2015 | (byte-compile-tag-number 0) | |
2016 | (byte-compile-depth 0) | |
2017 | (byte-compile-maxdepth 0) | |
2018 | (byte-compile-output nil)) | |
d9e42bcf RS |
2019 | (if (memq byte-optimize '(t source)) |
2020 | (setq form (byte-optimize-form form for-effect))) | |
2021 | (while (and (eq (car-safe form) 'progn) (null (cdr (cdr form)))) | |
2022 | (setq form (nth 1 form))) | |
2023 | (if (and (eq 'byte-code (car-safe form)) | |
2024 | (not (memq byte-optimize '(t byte))) | |
2025 | (stringp (nth 1 form)) (vectorp (nth 2 form)) | |
2026 | (natnump (nth 3 form))) | |
2027 | form | |
2028 | (byte-compile-form form for-effect) | |
285cdf4e | 2029 | (byte-compile-out-toplevel for-effect output-type)))) |
1c393159 JB |
2030 | |
2031 | (defun byte-compile-out-toplevel (&optional for-effect output-type) | |
2032 | (if for-effect | |
2033 | ;; The stack is empty. Push a value to be returned from (byte-code ..). | |
2034 | (if (eq (car (car byte-compile-output)) 'byte-discard) | |
2035 | (setq byte-compile-output (cdr byte-compile-output)) | |
2036 | (byte-compile-push-constant | |
2037 | ;; Push any constant - preferably one which already is used, and | |
2038 | ;; a number or symbol - ie not some big sequence. The return value | |
2039 | ;; isn't returned, but it would be a shame if some textually large | |
2040 | ;; constant was not optimized away because we chose to return it. | |
2041 | (and (not (assq nil byte-compile-constants)) ; Nil is often there. | |
2042 | (let ((tmp (reverse byte-compile-constants))) | |
2043 | (while (and tmp (not (or (symbolp (car (car tmp))) | |
2044 | (numberp (car (car tmp)))))) | |
2045 | (setq tmp (cdr tmp))) | |
2046 | (car (car tmp))))))) | |
2047 | (byte-compile-out 'byte-return 0) | |
2048 | (setq byte-compile-output (nreverse byte-compile-output)) | |
2049 | (if (memq byte-optimize '(t byte)) | |
2050 | (setq byte-compile-output | |
2051 | (byte-optimize-lapcode byte-compile-output for-effect))) | |
2052 | ||
2053 | ;; Decompile trivial functions: | |
2054 | ;; only constants and variables, or a single funcall except in lambdas. | |
2055 | ;; Except for Lisp_Compiled objects, forms like (foo "hi") | |
2056 | ;; are still quicker than (byte-code "..." [foo "hi"] 2). | |
2057 | ;; Note that even (quote foo) must be parsed just as any subr by the | |
2058 | ;; interpreter, so quote should be compiled into byte-code in some contexts. | |
2059 | ;; What to leave uncompiled: | |
69dc83fd KH |
2060 | ;; lambda -> never. we used to leave it uncompiled if the body was |
2061 | ;; a single atom, but that causes confusion if the docstring | |
2062 | ;; uses the (file . pos) syntax. Besides, now that we have | |
2063 | ;; the Lisp_Compiled type, the compiled form is faster. | |
1c393159 JB |
2064 | ;; eval -> atom, quote or (function atom atom atom) |
2065 | ;; progn -> as <<same-as-eval>> or (progn <<same-as-eval>> atom) | |
2066 | ;; file -> as progn, but takes both quotes and atoms, and longer forms. | |
2067 | (let (rest | |
2068 | (maycall (not (eq output-type 'lambda))) ; t if we may make a funcall. | |
2069 | tmp body) | |
2070 | (cond | |
2071 | ;; #### This should be split out into byte-compile-nontrivial-function-p. | |
69dc83fd KH |
2072 | ((or (eq output-type 'lambda) |
2073 | (nthcdr (if (eq output-type 'file) 50 8) byte-compile-output) | |
1c393159 JB |
2074 | (assq 'TAG byte-compile-output) ; Not necessary, but speeds up a bit. |
2075 | (not (setq tmp (assq 'byte-return byte-compile-output))) | |
2076 | (progn | |
2077 | (setq rest (nreverse | |
2078 | (cdr (memq tmp (reverse byte-compile-output))))) | |
2079 | (while (cond | |
2080 | ((memq (car (car rest)) '(byte-varref byte-constant)) | |
2081 | (setq tmp (car (cdr (car rest)))) | |
469414a0 RS |
2082 | (if (if (eq (car (car rest)) 'byte-constant) |
2083 | (or (consp tmp) | |
2084 | (and (symbolp tmp) | |
2085 | (not (memq tmp '(nil t)))))) | |
2086 | (if maycall | |
2087 | (setq body (cons (list 'quote tmp) body))) | |
2088 | (setq body (cons tmp body)))) | |
1c393159 JB |
2089 | ((and maycall |
2090 | ;; Allow a funcall if at most one atom follows it. | |
2091 | (null (nthcdr 3 rest)) | |
2092 | (setq tmp (get (car (car rest)) 'byte-opcode-invert)) | |
2093 | (or (null (cdr rest)) | |
2094 | (and (memq output-type '(file progn t)) | |
2095 | (cdr (cdr rest)) | |
2096 | (eq (car (nth 1 rest)) 'byte-discard) | |
2097 | (progn (setq rest (cdr rest)) t)))) | |
2098 | (setq maycall nil) ; Only allow one real function call. | |
2099 | (setq body (nreverse body)) | |
2100 | (setq body (list | |
2101 | (if (and (eq tmp 'funcall) | |
2102 | (eq (car-safe (car body)) 'quote)) | |
2103 | (cons (nth 1 (car body)) (cdr body)) | |
2104 | (cons tmp body)))) | |
2105 | (or (eq output-type 'file) | |
2106 | (not (delq nil (mapcar 'consp (cdr (car body)))))))) | |
2107 | (setq rest (cdr rest))) | |
69dc83fd | 2108 | rest)) |
1c393159 JB |
2109 | (let ((byte-compile-vector (byte-compile-constants-vector))) |
2110 | (list 'byte-code (byte-compile-lapcode byte-compile-output) | |
2111 | byte-compile-vector byte-compile-maxdepth))) | |
2112 | ;; it's a trivial function | |
2113 | ((cdr body) (cons 'progn (nreverse body))) | |
2114 | ((car body))))) | |
2115 | ||
2116 | ;; Given BODY, compile it and return a new body. | |
2117 | (defun byte-compile-top-level-body (body &optional for-effect) | |
2118 | (setq body (byte-compile-top-level (cons 'progn body) for-effect t)) | |
2119 | (cond ((eq (car-safe body) 'progn) | |
2120 | (cdr body)) | |
2121 | (body | |
2122 | (list body)))) | |
2123 | \f | |
2124 | ;; This is the recursive entry point for compiling each subform of an | |
2125 | ;; expression. | |
2126 | ;; If for-effect is non-nil, byte-compile-form will output a byte-discard | |
2127 | ;; before terminating (ie no value will be left on the stack). | |
2128 | ;; A byte-compile handler may, when for-effect is non-nil, choose output code | |
2129 | ;; which does not leave a value on the stack, and then set for-effect to nil | |
2130 | ;; (to prevent byte-compile-form from outputting the byte-discard). | |
2131 | ;; If a handler wants to call another handler, it should do so via | |
2132 | ;; byte-compile-form, or take extreme care to handle for-effect correctly. | |
2133 | ;; (Use byte-compile-form-do-effect to reset the for-effect flag too.) | |
2134 | ;; | |
2135 | (defun byte-compile-form (form &optional for-effect) | |
2136 | (setq form (macroexpand form byte-compile-macro-environment)) | |
2137 | (cond ((not (consp form)) | |
2138 | (cond ((or (not (symbolp form)) (memq form '(nil t))) | |
2139 | (byte-compile-constant form)) | |
2140 | ((and for-effect byte-compile-delete-errors) | |
2141 | (setq for-effect nil)) | |
2142 | (t (byte-compile-variable-ref 'byte-varref form)))) | |
2143 | ((symbolp (car form)) | |
2144 | (let* ((fn (car form)) | |
2145 | (handler (get fn 'byte-compile))) | |
9e2b097b JB |
2146 | (if (memq fn '(t nil)) |
2147 | (byte-compile-warn "%s called as a function" fn)) | |
1c393159 | 2148 | (if (and handler |
e27c3564 JB |
2149 | (or (not (byte-compile-version-cond |
2150 | byte-compile-compatibility)) | |
1c393159 JB |
2151 | (not (get (get fn 'byte-opcode) 'emacs19-opcode)))) |
2152 | (funcall handler form) | |
2153 | (if (memq 'callargs byte-compile-warnings) | |
2154 | (byte-compile-callargs-warn form)) | |
2155 | (byte-compile-normal-call form)))) | |
ed015bdd | 2156 | ((and (or (byte-code-function-p (car form)) |
1c393159 JB |
2157 | (eq (car-safe (car form)) 'lambda)) |
2158 | ;; if the form comes out the same way it went in, that's | |
2159 | ;; because it was malformed, and we couldn't unfold it. | |
2160 | (not (eq form (setq form (byte-compile-unfold-lambda form))))) | |
2161 | (byte-compile-form form for-effect) | |
2162 | (setq for-effect nil)) | |
2163 | ((byte-compile-normal-call form))) | |
2164 | (if for-effect | |
2165 | (byte-compile-discard))) | |
2166 | ||
2167 | (defun byte-compile-normal-call (form) | |
2168 | (if byte-compile-generate-call-tree | |
2169 | (byte-compile-annotate-call-tree form)) | |
2170 | (byte-compile-push-constant (car form)) | |
2171 | (mapcar 'byte-compile-form (cdr form)) ; wasteful, but faster. | |
2172 | (byte-compile-out 'byte-call (length (cdr form)))) | |
2173 | ||
2174 | (defun byte-compile-variable-ref (base-op var) | |
2175 | (if (or (not (symbolp var)) (memq var '(nil t))) | |
2176 | (byte-compile-warn (if (eq base-op 'byte-varbind) | |
2177 | "Attempt to let-bind %s %s" | |
2178 | "Variable reference to %s %s") | |
2179 | (if (symbolp var) "constant" "nonvariable") | |
2180 | (prin1-to-string var)) | |
9290191f RS |
2181 | (if (and (get var 'byte-obsolete-variable) |
2182 | (memq 'obsolete byte-compile-warnings)) | |
9e2b097b JB |
2183 | (let ((ob (get var 'byte-obsolete-variable))) |
2184 | (byte-compile-warn "%s is an obsolete variable; %s" var | |
2185 | (if (stringp ob) | |
2186 | ob | |
2187 | (format "use %s instead." ob))))) | |
1c393159 JB |
2188 | (if (memq 'free-vars byte-compile-warnings) |
2189 | (if (eq base-op 'byte-varbind) | |
2190 | (setq byte-compile-bound-variables | |
2191 | (cons var byte-compile-bound-variables)) | |
2192 | (or (boundp var) | |
2193 | (memq var byte-compile-bound-variables) | |
2194 | (if (eq base-op 'byte-varset) | |
2195 | (or (memq var byte-compile-free-assignments) | |
2196 | (progn | |
2197 | (byte-compile-warn "assignment to free variable %s" var) | |
2198 | (setq byte-compile-free-assignments | |
2199 | (cons var byte-compile-free-assignments)))) | |
2200 | (or (memq var byte-compile-free-references) | |
2201 | (progn | |
2202 | (byte-compile-warn "reference to free variable %s" var) | |
2203 | (setq byte-compile-free-references | |
2204 | (cons var byte-compile-free-references))))))))) | |
2205 | (let ((tmp (assq var byte-compile-variables))) | |
2206 | (or tmp | |
2207 | (setq tmp (list var) | |
2208 | byte-compile-variables (cons tmp byte-compile-variables))) | |
2209 | (byte-compile-out base-op tmp))) | |
2210 | ||
2211 | (defmacro byte-compile-get-constant (const) | |
2212 | (` (or (if (stringp (, const)) | |
2213 | (assoc (, const) byte-compile-constants) | |
2214 | (assq (, const) byte-compile-constants)) | |
2215 | (car (setq byte-compile-constants | |
2216 | (cons (list (, const)) byte-compile-constants)))))) | |
2217 | ||
2218 | ;; Use this when the value of a form is a constant. This obeys for-effect. | |
2219 | (defun byte-compile-constant (const) | |
2220 | (if for-effect | |
2221 | (setq for-effect nil) | |
2222 | (byte-compile-out 'byte-constant (byte-compile-get-constant const)))) | |
2223 | ||
2224 | ;; Use this for a constant that is not the value of its containing form. | |
2225 | ;; This ignores for-effect. | |
2226 | (defun byte-compile-push-constant (const) | |
2227 | (let ((for-effect nil)) | |
2228 | (inline (byte-compile-constant const)))) | |
2229 | ||
2230 | \f | |
2231 | ;; Compile those primitive ordinary functions | |
2232 | ;; which have special byte codes just for speed. | |
2233 | ||
2234 | (defmacro byte-defop-compiler (function &optional compile-handler) | |
2235 | ;; add a compiler-form for FUNCTION. | |
2236 | ;; If function is a symbol, then the variable "byte-SYMBOL" must name | |
2237 | ;; the opcode to be used. If function is a list, the first element | |
2238 | ;; is the function and the second element is the bytecode-symbol. | |
2239 | ;; COMPILE-HANDLER is the function to use to compile this byte-op, or | |
2240 | ;; may be the abbreviations 0, 1, 2, 3, 0-1, or 1-2. | |
2241 | ;; If it is nil, then the handler is "byte-compile-SYMBOL." | |
2242 | (let (opcode) | |
2243 | (if (symbolp function) | |
2244 | (setq opcode (intern (concat "byte-" (symbol-name function)))) | |
2245 | (setq opcode (car (cdr function)) | |
2246 | function (car function))) | |
2247 | (let ((fnform | |
2248 | (list 'put (list 'quote function) ''byte-compile | |
2249 | (list 'quote | |
2250 | (or (cdr (assq compile-handler | |
2251 | '((0 . byte-compile-no-args) | |
2252 | (1 . byte-compile-one-arg) | |
2253 | (2 . byte-compile-two-args) | |
2254 | (3 . byte-compile-three-args) | |
2255 | (0-1 . byte-compile-zero-or-one-arg) | |
2256 | (1-2 . byte-compile-one-or-two-args) | |
2257 | (2-3 . byte-compile-two-or-three-args) | |
2258 | ))) | |
2259 | compile-handler | |
2260 | (intern (concat "byte-compile-" | |
2261 | (symbol-name function)))))))) | |
2262 | (if opcode | |
2263 | (list 'progn fnform | |
2264 | (list 'put (list 'quote function) | |
2265 | ''byte-opcode (list 'quote opcode)) | |
2266 | (list 'put (list 'quote opcode) | |
2267 | ''byte-opcode-invert (list 'quote function))) | |
2268 | fnform)))) | |
2269 | ||
2270 | (defmacro byte-defop-compiler19 (function &optional compile-handler) | |
2271 | ;; Just like byte-defop-compiler, but defines an opcode that will only | |
e27c3564 | 2272 | ;; be used when byte-compile-compatibility is false. |
1c393159 | 2273 | (if (and (byte-compile-single-version) |
e27c3564 | 2274 | byte-compile-compatibility) |
9e2b097b JB |
2275 | ;; #### instead of doing nothing, this should do some remprops, |
2276 | ;; #### to protect against the case where a single-version compiler | |
2277 | ;; #### is loaded into a world that has contained a multi-version one. | |
1c393159 JB |
2278 | nil |
2279 | (list 'progn | |
2280 | (list 'put | |
2281 | (list 'quote | |
2282 | (or (car (cdr-safe function)) | |
2283 | (intern (concat "byte-" | |
2284 | (symbol-name (or (car-safe function) function)))))) | |
2285 | ''emacs19-opcode t) | |
2286 | (list 'byte-defop-compiler function compile-handler)))) | |
2287 | ||
2288 | (defmacro byte-defop-compiler-1 (function &optional compile-handler) | |
2289 | (list 'byte-defop-compiler (list function nil) compile-handler)) | |
2290 | ||
2291 | \f | |
2292 | (put 'byte-call 'byte-opcode-invert 'funcall) | |
2293 | (put 'byte-list1 'byte-opcode-invert 'list) | |
2294 | (put 'byte-list2 'byte-opcode-invert 'list) | |
2295 | (put 'byte-list3 'byte-opcode-invert 'list) | |
2296 | (put 'byte-list4 'byte-opcode-invert 'list) | |
2297 | (put 'byte-listN 'byte-opcode-invert 'list) | |
2298 | (put 'byte-concat2 'byte-opcode-invert 'concat) | |
2299 | (put 'byte-concat3 'byte-opcode-invert 'concat) | |
2300 | (put 'byte-concat4 'byte-opcode-invert 'concat) | |
2301 | (put 'byte-concatN 'byte-opcode-invert 'concat) | |
2302 | (put 'byte-insertN 'byte-opcode-invert 'insert) | |
2303 | ||
2304 | (byte-defop-compiler (dot byte-point) 0) | |
2305 | (byte-defop-compiler (dot-max byte-point-max) 0) | |
2306 | (byte-defop-compiler (dot-min byte-point-min) 0) | |
2307 | (byte-defop-compiler point 0) | |
2308 | ;;(byte-defop-compiler mark 0) ;; obsolete | |
2309 | (byte-defop-compiler point-max 0) | |
2310 | (byte-defop-compiler point-min 0) | |
2311 | (byte-defop-compiler following-char 0) | |
2312 | (byte-defop-compiler preceding-char 0) | |
2313 | (byte-defop-compiler current-column 0) | |
2314 | (byte-defop-compiler eolp 0) | |
2315 | (byte-defop-compiler eobp 0) | |
2316 | (byte-defop-compiler bolp 0) | |
2317 | (byte-defop-compiler bobp 0) | |
2318 | (byte-defop-compiler current-buffer 0) | |
2319 | ;;(byte-defop-compiler read-char 0) ;; obsolete | |
2320 | (byte-defop-compiler interactive-p 0) | |
2321 | (byte-defop-compiler19 widen 0) | |
2322 | (byte-defop-compiler19 end-of-line 0-1) | |
2323 | (byte-defop-compiler19 forward-char 0-1) | |
2324 | (byte-defop-compiler19 forward-line 0-1) | |
2325 | (byte-defop-compiler symbolp 1) | |
2326 | (byte-defop-compiler consp 1) | |
2327 | (byte-defop-compiler stringp 1) | |
2328 | (byte-defop-compiler listp 1) | |
2329 | (byte-defop-compiler not 1) | |
2330 | (byte-defop-compiler (null byte-not) 1) | |
2331 | (byte-defop-compiler car 1) | |
2332 | (byte-defop-compiler cdr 1) | |
2333 | (byte-defop-compiler length 1) | |
2334 | (byte-defop-compiler symbol-value 1) | |
2335 | (byte-defop-compiler symbol-function 1) | |
2336 | (byte-defop-compiler (1+ byte-add1) 1) | |
2337 | (byte-defop-compiler (1- byte-sub1) 1) | |
2338 | (byte-defop-compiler goto-char 1) | |
b8ae93ad | 2339 | (byte-defop-compiler char-after 0-1) |
1c393159 JB |
2340 | (byte-defop-compiler set-buffer 1) |
2341 | ;;(byte-defop-compiler set-mark 1) ;; obsolete | |
2342 | (byte-defop-compiler19 forward-word 1) | |
2343 | (byte-defop-compiler19 char-syntax 1) | |
2344 | (byte-defop-compiler19 nreverse 1) | |
2345 | (byte-defop-compiler19 car-safe 1) | |
2346 | (byte-defop-compiler19 cdr-safe 1) | |
2347 | (byte-defop-compiler19 numberp 1) | |
2348 | (byte-defop-compiler19 integerp 1) | |
2349 | (byte-defop-compiler19 skip-chars-forward 1-2) | |
2350 | (byte-defop-compiler19 skip-chars-backward 1-2) | |
1c393159 JB |
2351 | (byte-defop-compiler eq 2) |
2352 | (byte-defop-compiler memq 2) | |
2353 | (byte-defop-compiler cons 2) | |
2354 | (byte-defop-compiler aref 2) | |
2355 | (byte-defop-compiler set 2) | |
2356 | (byte-defop-compiler (= byte-eqlsign) 2) | |
2357 | (byte-defop-compiler (< byte-lss) 2) | |
2358 | (byte-defop-compiler (> byte-gtr) 2) | |
2359 | (byte-defop-compiler (<= byte-leq) 2) | |
2360 | (byte-defop-compiler (>= byte-geq) 2) | |
2361 | (byte-defop-compiler get 2) | |
2362 | (byte-defop-compiler nth 2) | |
2363 | (byte-defop-compiler substring 2-3) | |
9e2b097b | 2364 | (byte-defop-compiler19 (move-marker byte-set-marker) 2-3) |
1c393159 JB |
2365 | (byte-defop-compiler19 set-marker 2-3) |
2366 | (byte-defop-compiler19 match-beginning 1) | |
2367 | (byte-defop-compiler19 match-end 1) | |
2368 | (byte-defop-compiler19 upcase 1) | |
2369 | (byte-defop-compiler19 downcase 1) | |
2370 | (byte-defop-compiler19 string= 2) | |
2371 | (byte-defop-compiler19 string< 2) | |
9e2b097b JB |
2372 | (byte-defop-compiler19 (string-equal byte-string=) 2) |
2373 | (byte-defop-compiler19 (string-lessp byte-string<) 2) | |
1c393159 JB |
2374 | (byte-defop-compiler19 equal 2) |
2375 | (byte-defop-compiler19 nthcdr 2) | |
2376 | (byte-defop-compiler19 elt 2) | |
2377 | (byte-defop-compiler19 member 2) | |
2378 | (byte-defop-compiler19 assq 2) | |
9e2b097b JB |
2379 | (byte-defop-compiler19 (rplaca byte-setcar) 2) |
2380 | (byte-defop-compiler19 (rplacd byte-setcdr) 2) | |
1c393159 JB |
2381 | (byte-defop-compiler19 setcar 2) |
2382 | (byte-defop-compiler19 setcdr 2) | |
2383 | (byte-defop-compiler19 buffer-substring 2) | |
2384 | (byte-defop-compiler19 delete-region 2) | |
2385 | (byte-defop-compiler19 narrow-to-region 2) | |
1c393159 JB |
2386 | (byte-defop-compiler19 (% byte-rem) 2) |
2387 | (byte-defop-compiler aset 3) | |
2388 | ||
2389 | (byte-defop-compiler max byte-compile-associative) | |
2390 | (byte-defop-compiler min byte-compile-associative) | |
2391 | (byte-defop-compiler (+ byte-plus) byte-compile-associative) | |
2392 | (byte-defop-compiler19 (* byte-mult) byte-compile-associative) | |
2393 | ||
2394 | ;;####(byte-defop-compiler19 move-to-column 1) | |
2395 | (byte-defop-compiler-1 interactive byte-compile-noop) | |
2396 | ||
2397 | \f | |
2398 | (defun byte-compile-subr-wrong-args (form n) | |
2399 | (byte-compile-warn "%s called with %d arg%s, but requires %s" | |
2400 | (car form) (length (cdr form)) | |
2401 | (if (= 1 (length (cdr form))) "" "s") n) | |
2402 | ;; get run-time wrong-number-of-args error. | |
2403 | (byte-compile-normal-call form)) | |
2404 | ||
2405 | (defun byte-compile-no-args (form) | |
2406 | (if (not (= (length form) 1)) | |
2407 | (byte-compile-subr-wrong-args form "none") | |
2408 | (byte-compile-out (get (car form) 'byte-opcode) 0))) | |
2409 | ||
2410 | (defun byte-compile-one-arg (form) | |
2411 | (if (not (= (length form) 2)) | |
2412 | (byte-compile-subr-wrong-args form 1) | |
2413 | (byte-compile-form (car (cdr form))) ;; Push the argument | |
2414 | (byte-compile-out (get (car form) 'byte-opcode) 0))) | |
2415 | ||
2416 | (defun byte-compile-two-args (form) | |
2417 | (if (not (= (length form) 3)) | |
2418 | (byte-compile-subr-wrong-args form 2) | |
2419 | (byte-compile-form (car (cdr form))) ;; Push the arguments | |
2420 | (byte-compile-form (nth 2 form)) | |
2421 | (byte-compile-out (get (car form) 'byte-opcode) 0))) | |
2422 | ||
2423 | (defun byte-compile-three-args (form) | |
2424 | (if (not (= (length form) 4)) | |
2425 | (byte-compile-subr-wrong-args form 3) | |
2426 | (byte-compile-form (car (cdr form))) ;; Push the arguments | |
2427 | (byte-compile-form (nth 2 form)) | |
2428 | (byte-compile-form (nth 3 form)) | |
2429 | (byte-compile-out (get (car form) 'byte-opcode) 0))) | |
2430 | ||
2431 | (defun byte-compile-zero-or-one-arg (form) | |
2432 | (let ((len (length form))) | |
2433 | (cond ((= len 1) (byte-compile-one-arg (append form '(nil)))) | |
2434 | ((= len 2) (byte-compile-one-arg form)) | |
2435 | (t (byte-compile-subr-wrong-args form "0-1"))))) | |
2436 | ||
2437 | (defun byte-compile-one-or-two-args (form) | |
2438 | (let ((len (length form))) | |
2439 | (cond ((= len 2) (byte-compile-two-args (append form '(nil)))) | |
2440 | ((= len 3) (byte-compile-two-args form)) | |
2441 | (t (byte-compile-subr-wrong-args form "1-2"))))) | |
2442 | ||
2443 | (defun byte-compile-two-or-three-args (form) | |
2444 | (let ((len (length form))) | |
2445 | (cond ((= len 3) (byte-compile-three-args (append form '(nil)))) | |
2446 | ((= len 4) (byte-compile-three-args form)) | |
2447 | (t (byte-compile-subr-wrong-args form "2-3"))))) | |
2448 | ||
2449 | (defun byte-compile-noop (form) | |
2450 | (byte-compile-constant nil)) | |
2451 | ||
2452 | (defun byte-compile-discard () | |
2453 | (byte-compile-out 'byte-discard 0)) | |
2454 | ||
2455 | ||
2456 | ;; Compile a function that accepts one or more args and is right-associative. | |
c0f43df5 RS |
2457 | ;; We do it by left-associativity so that the operations |
2458 | ;; are done in the same order as in interpreted code. | |
10809e0f RS |
2459 | ;; We treat the one-arg case, as in (+ x), like (+ x 0). |
2460 | ;; in order to convert markers to numbers, and trigger expected errors. | |
1c393159 JB |
2461 | (defun byte-compile-associative (form) |
2462 | (if (cdr form) | |
c0f43df5 RS |
2463 | (let ((opcode (get (car form) 'byte-opcode)) |
2464 | (args (copy-sequence (cdr form)))) | |
2465 | (byte-compile-form (car args)) | |
2466 | (setq args (cdr args)) | |
10809e0f RS |
2467 | (or args (setq args '(0) |
2468 | opcode (get '+ 'byte-opcode))) | |
c0f43df5 RS |
2469 | (while args |
2470 | (byte-compile-form (car args)) | |
2471 | (byte-compile-out opcode 0) | |
2472 | (setq args (cdr args)))) | |
1c393159 JB |
2473 | (byte-compile-constant (eval form)))) |
2474 | ||
2475 | \f | |
2476 | ;; more complicated compiler macros | |
2477 | ||
2478 | (byte-defop-compiler list) | |
2479 | (byte-defop-compiler concat) | |
2480 | (byte-defop-compiler fset) | |
2481 | (byte-defop-compiler (indent-to-column byte-indent-to) byte-compile-indent-to) | |
2482 | (byte-defop-compiler indent-to) | |
2483 | (byte-defop-compiler insert) | |
2484 | (byte-defop-compiler-1 function byte-compile-function-form) | |
2485 | (byte-defop-compiler-1 - byte-compile-minus) | |
2486 | (byte-defop-compiler19 (/ byte-quo) byte-compile-quo) | |
2487 | (byte-defop-compiler19 nconc) | |
2488 | (byte-defop-compiler-1 beginning-of-line) | |
2489 | ||
2490 | (defun byte-compile-list (form) | |
2491 | (let ((count (length (cdr form)))) | |
2492 | (cond ((= count 0) | |
2493 | (byte-compile-constant nil)) | |
2494 | ((< count 5) | |
2495 | (mapcar 'byte-compile-form (cdr form)) | |
2496 | (byte-compile-out | |
2497 | (aref [byte-list1 byte-list2 byte-list3 byte-list4] (1- count)) 0)) | |
e27c3564 JB |
2498 | ((and (< count 256) (not (byte-compile-version-cond |
2499 | byte-compile-compatibility))) | |
1c393159 JB |
2500 | (mapcar 'byte-compile-form (cdr form)) |
2501 | (byte-compile-out 'byte-listN count)) | |
2502 | (t (byte-compile-normal-call form))))) | |
2503 | ||
2504 | (defun byte-compile-concat (form) | |
2505 | (let ((count (length (cdr form)))) | |
2506 | (cond ((and (< 1 count) (< count 5)) | |
2507 | (mapcar 'byte-compile-form (cdr form)) | |
2508 | (byte-compile-out | |
2509 | (aref [byte-concat2 byte-concat3 byte-concat4] (- count 2)) | |
2510 | 0)) | |
2511 | ;; Concat of one arg is not a no-op if arg is not a string. | |
2512 | ((= count 0) | |
2513 | (byte-compile-form "")) | |
e27c3564 JB |
2514 | ((and (< count 256) (not (byte-compile-version-cond |
2515 | byte-compile-compatibility))) | |
1c393159 JB |
2516 | (mapcar 'byte-compile-form (cdr form)) |
2517 | (byte-compile-out 'byte-concatN count)) | |
2518 | ((byte-compile-normal-call form))))) | |
2519 | ||
2520 | (defun byte-compile-minus (form) | |
2521 | (if (null (setq form (cdr form))) | |
2522 | (byte-compile-constant 0) | |
2523 | (byte-compile-form (car form)) | |
2524 | (if (cdr form) | |
2525 | (while (setq form (cdr form)) | |
2526 | (byte-compile-form (car form)) | |
2527 | (byte-compile-out 'byte-diff 0)) | |
2528 | (byte-compile-out 'byte-negate 0)))) | |
2529 | ||
2530 | (defun byte-compile-quo (form) | |
2531 | (let ((len (length form))) | |
2532 | (cond ((<= len 2) | |
2533 | (byte-compile-subr-wrong-args form "2 or more")) | |
2534 | (t | |
2535 | (byte-compile-form (car (setq form (cdr form)))) | |
2536 | (while (setq form (cdr form)) | |
2537 | (byte-compile-form (car form)) | |
2538 | (byte-compile-out 'byte-quo 0)))))) | |
2539 | ||
2540 | (defun byte-compile-nconc (form) | |
2541 | (let ((len (length form))) | |
2542 | (cond ((= len 1) | |
2543 | (byte-compile-constant nil)) | |
2544 | ((= len 2) | |
2545 | ;; nconc of one arg is a noop, even if that arg isn't a list. | |
2546 | (byte-compile-form (nth 1 form))) | |
2547 | (t | |
2548 | (byte-compile-form (car (setq form (cdr form)))) | |
2549 | (while (setq form (cdr form)) | |
2550 | (byte-compile-form (car form)) | |
2551 | (byte-compile-out 'byte-nconc 0)))))) | |
2552 | ||
2553 | (defun byte-compile-fset (form) | |
2554 | ;; warn about forms like (fset 'foo '(lambda () ...)) | |
2555 | ;; (where the lambda expression is non-trivial...) | |
2556 | (let ((fn (nth 2 form)) | |
2557 | body) | |
2558 | (if (and (eq (car-safe fn) 'quote) | |
2559 | (eq (car-safe (setq fn (nth 1 fn))) 'lambda)) | |
2560 | (progn | |
2561 | (setq body (cdr (cdr fn))) | |
2562 | (if (stringp (car body)) (setq body (cdr body))) | |
2563 | (if (eq 'interactive (car-safe (car body))) (setq body (cdr body))) | |
2564 | (if (and (consp (car body)) | |
2565 | (not (eq 'byte-code (car (car body))))) | |
2566 | (byte-compile-warn | |
2567 | "A quoted lambda form is the second argument of fset. This is probably | |
2568 | not what you want, as that lambda cannot be compiled. Consider using | |
2569 | the syntax (function (lambda (...) ...)) instead."))))) | |
2570 | (byte-compile-two-args form)) | |
2571 | ||
2572 | (defun byte-compile-funarg (form) | |
2573 | ;; (mapcar '(lambda (x) ..) ..) ==> (mapcar (function (lambda (x) ..)) ..) | |
eb8c3be9 | 2574 | ;; for cases where it's guaranteed that first arg will be used as a lambda. |
1c393159 JB |
2575 | (byte-compile-normal-call |
2576 | (let ((fn (nth 1 form))) | |
2577 | (if (and (eq (car-safe fn) 'quote) | |
2578 | (eq (car-safe (nth 1 fn)) 'lambda)) | |
2579 | (cons (car form) | |
2580 | (cons (cons 'function (cdr fn)) | |
2581 | (cdr (cdr form)))) | |
2582 | form)))) | |
2583 | ||
5a6037bb RS |
2584 | (defun byte-compile-funarg-2 (form) |
2585 | ;; (sort ... '(lambda (x) ..)) ==> (sort ... (function (lambda (x) ..))) | |
2586 | ;; for cases where it's guaranteed that second arg will be used as a lambda. | |
2587 | (byte-compile-normal-call | |
2588 | (let ((fn (nth 2 form))) | |
2589 | (if (and (eq (car-safe fn) 'quote) | |
2590 | (eq (car-safe (nth 1 fn)) 'lambda)) | |
2591 | (cons (car form) | |
2592 | (cons (nth 1 form) | |
2593 | (cons (cons 'function (cdr fn)) | |
2594 | (cdr (cdr (cdr form)))))) | |
2595 | form)))) | |
2596 | ||
1c393159 JB |
2597 | ;; (function foo) must compile like 'foo, not like (symbol-function 'foo). |
2598 | ;; Otherwise it will be incompatible with the interpreter, | |
2599 | ;; and (funcall (function foo)) will lose with autoloads. | |
2600 | ||
2601 | (defun byte-compile-function-form (form) | |
2602 | (byte-compile-constant | |
2603 | (cond ((symbolp (nth 1 form)) | |
2604 | (nth 1 form)) | |
2605 | ;; If we're not allowed to use #[] syntax, then output a form like | |
2606 | ;; '(lambda (..) (byte-code ..)) instead of a call to make-byte-code. | |
2607 | ;; In this situation, calling make-byte-code at run-time will usually | |
2608 | ;; be less efficient than processing a call to byte-code. | |
52799cb8 | 2609 | ((byte-compile-version-cond byte-compile-compatibility) |
1c393159 JB |
2610 | (byte-compile-byte-code-unmake (byte-compile-lambda (nth 1 form)))) |
2611 | ((byte-compile-lambda (nth 1 form)))))) | |
2612 | ||
2613 | (defun byte-compile-indent-to (form) | |
2614 | (let ((len (length form))) | |
2615 | (cond ((= len 2) | |
2616 | (byte-compile-form (car (cdr form))) | |
2617 | (byte-compile-out 'byte-indent-to 0)) | |
2618 | ((= len 3) | |
2619 | ;; no opcode for 2-arg case. | |
2620 | (byte-compile-normal-call form)) | |
2621 | (t | |
2622 | (byte-compile-subr-wrong-args form "1-2"))))) | |
2623 | ||
2624 | (defun byte-compile-insert (form) | |
2625 | (cond ((null (cdr form)) | |
2626 | (byte-compile-constant nil)) | |
e27c3564 JB |
2627 | ((and (not (byte-compile-version-cond |
2628 | byte-compile-compatibility)) | |
1c393159 JB |
2629 | (<= (length form) 256)) |
2630 | (mapcar 'byte-compile-form (cdr form)) | |
2631 | (if (cdr (cdr form)) | |
2632 | (byte-compile-out 'byte-insertN (length (cdr form))) | |
2633 | (byte-compile-out 'byte-insert 0))) | |
2634 | ((memq t (mapcar 'consp (cdr (cdr form)))) | |
2635 | (byte-compile-normal-call form)) | |
2636 | ;; We can split it; there is no function call after inserting 1st arg. | |
2637 | (t | |
2638 | (while (setq form (cdr form)) | |
2639 | (byte-compile-form (car form)) | |
2640 | (byte-compile-out 'byte-insert 0) | |
2641 | (if (cdr form) | |
2642 | (byte-compile-discard)))))) | |
2643 | ||
2644 | (defun byte-compile-beginning-of-line (form) | |
2645 | (if (not (byte-compile-constp (nth 1 form))) | |
2646 | (byte-compile-normal-call form) | |
2647 | (byte-compile-form | |
2648 | (list 'forward-line | |
2649 | (if (integerp (setq form (or (eval (nth 1 form)) 1))) | |
2650 | (1- form) | |
2651 | (byte-compile-warn "Non-numeric arg to beginning-of-line: %s" | |
2652 | form) | |
2653 | (list '1- (list 'quote form)))) | |
2654 | t) | |
2655 | (byte-compile-constant nil))) | |
2656 | ||
2657 | \f | |
2658 | (byte-defop-compiler-1 setq) | |
2659 | (byte-defop-compiler-1 setq-default) | |
2660 | (byte-defop-compiler-1 quote) | |
2661 | (byte-defop-compiler-1 quote-form) | |
2662 | ||
2663 | (defun byte-compile-setq (form) | |
2664 | (let ((args (cdr form))) | |
2665 | (if args | |
2666 | (while args | |
2667 | (byte-compile-form (car (cdr args))) | |
2668 | (or for-effect (cdr (cdr args)) | |
2669 | (byte-compile-out 'byte-dup 0)) | |
2670 | (byte-compile-variable-ref 'byte-varset (car args)) | |
2671 | (setq args (cdr (cdr args)))) | |
2672 | ;; (setq), with no arguments. | |
2673 | (byte-compile-form nil for-effect)) | |
2674 | (setq for-effect nil))) | |
2675 | ||
2676 | (defun byte-compile-setq-default (form) | |
ca38179a RS |
2677 | (let ((args (cdr form)) |
2678 | setters) | |
2679 | (while args | |
2680 | (setq setters | |
2681 | (cons (list 'set-default (list 'quote (car args)) (car (cdr args))) | |
2682 | setters)) | |
2683 | (setq args (cdr (cdr args)))) | |
2684 | (byte-compile-form (cons 'progn (nreverse setters))))) | |
1c393159 JB |
2685 | |
2686 | (defun byte-compile-quote (form) | |
2687 | (byte-compile-constant (car (cdr form)))) | |
2688 | ||
2689 | (defun byte-compile-quote-form (form) | |
2690 | (byte-compile-constant (byte-compile-top-level (nth 1 form)))) | |
2691 | ||
2692 | \f | |
2693 | ;;; control structures | |
2694 | ||
2695 | (defun byte-compile-body (body &optional for-effect) | |
2696 | (while (cdr body) | |
2697 | (byte-compile-form (car body) t) | |
2698 | (setq body (cdr body))) | |
2699 | (byte-compile-form (car body) for-effect)) | |
2700 | ||
52799cb8 | 2701 | (defsubst byte-compile-body-do-effect (body) |
1c393159 JB |
2702 | (byte-compile-body body for-effect) |
2703 | (setq for-effect nil)) | |
2704 | ||
52799cb8 | 2705 | (defsubst byte-compile-form-do-effect (form) |
1c393159 JB |
2706 | (byte-compile-form form for-effect) |
2707 | (setq for-effect nil)) | |
2708 | ||
2709 | (byte-defop-compiler-1 inline byte-compile-progn) | |
2710 | (byte-defop-compiler-1 progn) | |
2711 | (byte-defop-compiler-1 prog1) | |
2712 | (byte-defop-compiler-1 prog2) | |
2713 | (byte-defop-compiler-1 if) | |
2714 | (byte-defop-compiler-1 cond) | |
2715 | (byte-defop-compiler-1 and) | |
2716 | (byte-defop-compiler-1 or) | |
2717 | (byte-defop-compiler-1 while) | |
2718 | (byte-defop-compiler-1 funcall) | |
2719 | (byte-defop-compiler-1 apply byte-compile-funarg) | |
2720 | (byte-defop-compiler-1 mapcar byte-compile-funarg) | |
2721 | (byte-defop-compiler-1 mapatoms byte-compile-funarg) | |
2722 | (byte-defop-compiler-1 mapconcat byte-compile-funarg) | |
5a6037bb | 2723 | (byte-defop-compiler-1 sort byte-compile-funarg-2) |
1c393159 JB |
2724 | (byte-defop-compiler-1 let) |
2725 | (byte-defop-compiler-1 let*) | |
2726 | ||
2727 | (defun byte-compile-progn (form) | |
2728 | (byte-compile-body-do-effect (cdr form))) | |
2729 | ||
2730 | (defun byte-compile-prog1 (form) | |
2731 | (byte-compile-form-do-effect (car (cdr form))) | |
2732 | (byte-compile-body (cdr (cdr form)) t)) | |
2733 | ||
2734 | (defun byte-compile-prog2 (form) | |
2735 | (byte-compile-form (nth 1 form) t) | |
2736 | (byte-compile-form-do-effect (nth 2 form)) | |
2737 | (byte-compile-body (cdr (cdr (cdr form))) t)) | |
2738 | ||
2739 | (defmacro byte-compile-goto-if (cond discard tag) | |
2740 | (` (byte-compile-goto | |
2741 | (if (, cond) | |
2742 | (if (, discard) 'byte-goto-if-not-nil 'byte-goto-if-not-nil-else-pop) | |
2743 | (if (, discard) 'byte-goto-if-nil 'byte-goto-if-nil-else-pop)) | |
2744 | (, tag)))) | |
2745 | ||
2746 | (defun byte-compile-if (form) | |
2747 | (byte-compile-form (car (cdr form))) | |
2748 | (if (null (nthcdr 3 form)) | |
2749 | ;; No else-forms | |
2750 | (let ((donetag (byte-compile-make-tag))) | |
2751 | (byte-compile-goto-if nil for-effect donetag) | |
2752 | (byte-compile-form (nth 2 form) for-effect) | |
2753 | (byte-compile-out-tag donetag)) | |
2754 | (let ((donetag (byte-compile-make-tag)) (elsetag (byte-compile-make-tag))) | |
2755 | (byte-compile-goto 'byte-goto-if-nil elsetag) | |
2756 | (byte-compile-form (nth 2 form) for-effect) | |
2757 | (byte-compile-goto 'byte-goto donetag) | |
2758 | (byte-compile-out-tag elsetag) | |
2759 | (byte-compile-body (cdr (cdr (cdr form))) for-effect) | |
2760 | (byte-compile-out-tag donetag))) | |
2761 | (setq for-effect nil)) | |
2762 | ||
2763 | (defun byte-compile-cond (clauses) | |
2764 | (let ((donetag (byte-compile-make-tag)) | |
2765 | nexttag clause) | |
2766 | (while (setq clauses (cdr clauses)) | |
2767 | (setq clause (car clauses)) | |
2768 | (cond ((or (eq (car clause) t) | |
2769 | (and (eq (car-safe (car clause)) 'quote) | |
2770 | (car-safe (cdr-safe (car clause))))) | |
2771 | ;; Unconditional clause | |
2772 | (setq clause (cons t clause) | |
2773 | clauses nil)) | |
2774 | ((cdr clauses) | |
2775 | (byte-compile-form (car clause)) | |
2776 | (if (null (cdr clause)) | |
2777 | ;; First clause is a singleton. | |
2778 | (byte-compile-goto-if t for-effect donetag) | |
2779 | (setq nexttag (byte-compile-make-tag)) | |
2780 | (byte-compile-goto 'byte-goto-if-nil nexttag) | |
2781 | (byte-compile-body (cdr clause) for-effect) | |
2782 | (byte-compile-goto 'byte-goto donetag) | |
2783 | (byte-compile-out-tag nexttag))))) | |
2784 | ;; Last clause | |
2785 | (and (cdr clause) (not (eq (car clause) t)) | |
2786 | (progn (byte-compile-form (car clause)) | |
2787 | (byte-compile-goto-if nil for-effect donetag) | |
2788 | (setq clause (cdr clause)))) | |
2789 | (byte-compile-body-do-effect clause) | |
2790 | (byte-compile-out-tag donetag))) | |
2791 | ||
2792 | (defun byte-compile-and (form) | |
2793 | (let ((failtag (byte-compile-make-tag)) | |
2794 | (args (cdr form))) | |
2795 | (if (null args) | |
2796 | (byte-compile-form-do-effect t) | |
2797 | (while (cdr args) | |
2798 | (byte-compile-form (car args)) | |
2799 | (byte-compile-goto-if nil for-effect failtag) | |
2800 | (setq args (cdr args))) | |
2801 | (byte-compile-form-do-effect (car args)) | |
2802 | (byte-compile-out-tag failtag)))) | |
2803 | ||
2804 | (defun byte-compile-or (form) | |
2805 | (let ((wintag (byte-compile-make-tag)) | |
2806 | (args (cdr form))) | |
2807 | (if (null args) | |
2808 | (byte-compile-form-do-effect nil) | |
2809 | (while (cdr args) | |
2810 | (byte-compile-form (car args)) | |
2811 | (byte-compile-goto-if t for-effect wintag) | |
2812 | (setq args (cdr args))) | |
2813 | (byte-compile-form-do-effect (car args)) | |
2814 | (byte-compile-out-tag wintag)))) | |
2815 | ||
2816 | (defun byte-compile-while (form) | |
2817 | (let ((endtag (byte-compile-make-tag)) | |
2818 | (looptag (byte-compile-make-tag))) | |
2819 | (byte-compile-out-tag looptag) | |
2820 | (byte-compile-form (car (cdr form))) | |
2821 | (byte-compile-goto-if nil for-effect endtag) | |
2822 | (byte-compile-body (cdr (cdr form)) t) | |
2823 | (byte-compile-goto 'byte-goto looptag) | |
2824 | (byte-compile-out-tag endtag) | |
2825 | (setq for-effect nil))) | |
2826 | ||
2827 | (defun byte-compile-funcall (form) | |
2828 | (mapcar 'byte-compile-form (cdr form)) | |
2829 | (byte-compile-out 'byte-call (length (cdr (cdr form))))) | |
2830 | ||
2831 | ||
2832 | (defun byte-compile-let (form) | |
2833 | ;; First compute the binding values in the old scope. | |
2834 | (let ((varlist (car (cdr form)))) | |
2835 | (while varlist | |
2836 | (if (consp (car varlist)) | |
2837 | (byte-compile-form (car (cdr (car varlist)))) | |
2838 | (byte-compile-push-constant nil)) | |
2839 | (setq varlist (cdr varlist)))) | |
2840 | (let ((byte-compile-bound-variables byte-compile-bound-variables) ;new scope | |
2841 | (varlist (reverse (car (cdr form))))) | |
2842 | (while varlist | |
2843 | (byte-compile-variable-ref 'byte-varbind (if (consp (car varlist)) | |
2844 | (car (car varlist)) | |
2845 | (car varlist))) | |
2846 | (setq varlist (cdr varlist))) | |
2847 | (byte-compile-body-do-effect (cdr (cdr form))) | |
2848 | (byte-compile-out 'byte-unbind (length (car (cdr form)))))) | |
2849 | ||
2850 | (defun byte-compile-let* (form) | |
2851 | (let ((byte-compile-bound-variables byte-compile-bound-variables) ;new scope | |
2852 | (varlist (copy-sequence (car (cdr form))))) | |
2853 | (while varlist | |
2854 | (if (atom (car varlist)) | |
2855 | (byte-compile-push-constant nil) | |
2856 | (byte-compile-form (car (cdr (car varlist)))) | |
2857 | (setcar varlist (car (car varlist)))) | |
2858 | (byte-compile-variable-ref 'byte-varbind (car varlist)) | |
2859 | (setq varlist (cdr varlist))) | |
2860 | (byte-compile-body-do-effect (cdr (cdr form))) | |
2861 | (byte-compile-out 'byte-unbind (length (car (cdr form)))))) | |
2862 | ||
2863 | ||
2864 | (byte-defop-compiler-1 /= byte-compile-negated) | |
2865 | (byte-defop-compiler-1 atom byte-compile-negated) | |
2866 | (byte-defop-compiler-1 nlistp byte-compile-negated) | |
2867 | ||
2868 | (put '/= 'byte-compile-negated-op '=) | |
2869 | (put 'atom 'byte-compile-negated-op 'consp) | |
2870 | (put 'nlistp 'byte-compile-negated-op 'listp) | |
2871 | ||
2872 | (defun byte-compile-negated (form) | |
2873 | (byte-compile-form-do-effect (byte-compile-negation-optimizer form))) | |
2874 | ||
2875 | ;; Even when optimization is off, /= is optimized to (not (= ...)). | |
2876 | (defun byte-compile-negation-optimizer (form) | |
2877 | ;; an optimizer for forms where <form1> is less efficient than (not <form2>) | |
2878 | (list 'not | |
2879 | (cons (or (get (car form) 'byte-compile-negated-op) | |
2880 | (error | |
52799cb8 | 2881 | "Compiler error: `%s' has no `byte-compile-negated-op' property" |
1c393159 JB |
2882 | (car form))) |
2883 | (cdr form)))) | |
2884 | \f | |
2885 | ;;; other tricky macro-like special-forms | |
2886 | ||
2887 | (byte-defop-compiler-1 catch) | |
2888 | (byte-defop-compiler-1 unwind-protect) | |
2889 | (byte-defop-compiler-1 condition-case) | |
2890 | (byte-defop-compiler-1 save-excursion) | |
f3e472b0 | 2891 | (byte-defop-compiler-1 save-current-buffer) |
1c393159 JB |
2892 | (byte-defop-compiler-1 save-restriction) |
2893 | (byte-defop-compiler-1 save-window-excursion) | |
2894 | (byte-defop-compiler-1 with-output-to-temp-buffer) | |
6e8d0db7 | 2895 | (byte-defop-compiler-1 track-mouse) |
1c393159 JB |
2896 | |
2897 | (defun byte-compile-catch (form) | |
2898 | (byte-compile-form (car (cdr form))) | |
2899 | (byte-compile-push-constant | |
2900 | (byte-compile-top-level (cons 'progn (cdr (cdr form))) for-effect)) | |
2901 | (byte-compile-out 'byte-catch 0)) | |
2902 | ||
2903 | (defun byte-compile-unwind-protect (form) | |
2904 | (byte-compile-push-constant | |
2905 | (byte-compile-top-level-body (cdr (cdr form)) t)) | |
2906 | (byte-compile-out 'byte-unwind-protect 0) | |
2907 | (byte-compile-form-do-effect (car (cdr form))) | |
2908 | (byte-compile-out 'byte-unbind 1)) | |
2909 | ||
6e8d0db7 | 2910 | (defun byte-compile-track-mouse (form) |
d7846e08 RS |
2911 | (byte-compile-form |
2912 | (list | |
2913 | 'funcall | |
2914 | (list 'quote | |
2915 | (list 'lambda nil | |
2916 | (cons 'track-mouse | |
2917 | (byte-compile-top-level-body (cdr form)))))))) | |
6e8d0db7 | 2918 | |
1c393159 JB |
2919 | (defun byte-compile-condition-case (form) |
2920 | (let* ((var (nth 1 form)) | |
2921 | (byte-compile-bound-variables | |
2922 | (if var (cons var byte-compile-bound-variables) | |
2923 | byte-compile-bound-variables))) | |
2924 | (or (symbolp var) | |
2925 | (byte-compile-warn | |
2926 | "%s is not a variable-name or nil (in condition-case)" var)) | |
2927 | (byte-compile-push-constant var) | |
2928 | (byte-compile-push-constant (byte-compile-top-level | |
2929 | (nth 2 form) for-effect)) | |
2930 | (let ((clauses (cdr (cdr (cdr form)))) | |
2931 | compiled-clauses) | |
2932 | (while clauses | |
e27c3564 JB |
2933 | (let* ((clause (car clauses)) |
2934 | (condition (car clause))) | |
2abcddce RS |
2935 | (cond ((not (or (symbolp condition) |
2936 | (and (listp condition) | |
2937 | (let ((syms condition) (ok t)) | |
2938 | (while syms | |
2939 | (if (not (symbolp (car syms))) | |
2940 | (setq ok nil)) | |
2941 | (setq syms (cdr syms))) | |
2942 | ok)))) | |
e27c3564 | 2943 | (byte-compile-warn |
2abcddce | 2944 | "%s is not a condition name or list of such (in condition-case)" |
e27c3564 | 2945 | (prin1-to-string condition))) |
2abcddce RS |
2946 | ;; ((not (or (eq condition 't) |
2947 | ;; (and (stringp (get condition 'error-message)) | |
2948 | ;; (consp (get condition 'error-conditions))))) | |
2949 | ;; (byte-compile-warn | |
2950 | ;; "%s is not a known condition name (in condition-case)" | |
2951 | ;; condition)) | |
2952 | ) | |
1c393159 | 2953 | (setq compiled-clauses |
e27c3564 | 2954 | (cons (cons condition |
1c393159 JB |
2955 | (byte-compile-top-level-body |
2956 | (cdr clause) for-effect)) | |
2957 | compiled-clauses))) | |
2958 | (setq clauses (cdr clauses))) | |
2959 | (byte-compile-push-constant (nreverse compiled-clauses))) | |
2960 | (byte-compile-out 'byte-condition-case 0))) | |
2961 | ||
2962 | ||
2963 | (defun byte-compile-save-excursion (form) | |
2964 | (byte-compile-out 'byte-save-excursion 0) | |
2965 | (byte-compile-body-do-effect (cdr form)) | |
2966 | (byte-compile-out 'byte-unbind 1)) | |
2967 | ||
2968 | (defun byte-compile-save-restriction (form) | |
2969 | (byte-compile-out 'byte-save-restriction 0) | |
2970 | (byte-compile-body-do-effect (cdr form)) | |
2971 | (byte-compile-out 'byte-unbind 1)) | |
2972 | ||
f3e472b0 RS |
2973 | (defun byte-compile-save-current-buffer (form) |
2974 | (byte-compile-out 'byte-save-current-buffer 0) | |
2975 | (byte-compile-body-do-effect (cdr form)) | |
2976 | (byte-compile-out 'byte-unbind 1)) | |
2977 | ||
1c393159 JB |
2978 | (defun byte-compile-save-window-excursion (form) |
2979 | (byte-compile-push-constant | |
2980 | (byte-compile-top-level-body (cdr form) for-effect)) | |
2981 | (byte-compile-out 'byte-save-window-excursion 0)) | |
2982 | ||
2983 | (defun byte-compile-with-output-to-temp-buffer (form) | |
2984 | (byte-compile-form (car (cdr form))) | |
2985 | (byte-compile-out 'byte-temp-output-buffer-setup 0) | |
2986 | (byte-compile-body (cdr (cdr form))) | |
2987 | (byte-compile-out 'byte-temp-output-buffer-show 0)) | |
2988 | ||
2989 | \f | |
2990 | ;;; top-level forms elsewhere | |
2991 | ||
2992 | (byte-defop-compiler-1 defun) | |
2993 | (byte-defop-compiler-1 defmacro) | |
2994 | (byte-defop-compiler-1 defvar) | |
2995 | (byte-defop-compiler-1 defconst byte-compile-defvar) | |
2996 | (byte-defop-compiler-1 autoload) | |
2997 | (byte-defop-compiler-1 lambda byte-compile-lambda-form) | |
5286a842 | 2998 | (byte-defop-compiler-1 defalias) |
1c393159 JB |
2999 | |
3000 | (defun byte-compile-defun (form) | |
3001 | ;; This is not used for file-level defuns with doc strings. | |
3002 | (byte-compile-two-args ; Use this to avoid byte-compile-fset's warning. | |
3003 | (list 'fset (list 'quote (nth 1 form)) | |
3004 | (byte-compile-byte-code-maker | |
3005 | (byte-compile-lambda (cons 'lambda (cdr (cdr form))))))) | |
3006 | (byte-compile-discard) | |
3007 | (byte-compile-constant (nth 1 form))) | |
3008 | ||
3009 | (defun byte-compile-defmacro (form) | |
3010 | ;; This is not used for file-level defmacros with doc strings. | |
3011 | (byte-compile-body-do-effect | |
3012 | (list (list 'fset (list 'quote (nth 1 form)) | |
3013 | (let ((code (byte-compile-byte-code-maker | |
3014 | (byte-compile-lambda | |
3015 | (cons 'lambda (cdr (cdr form))))))) | |
3016 | (if (eq (car-safe code) 'make-byte-code) | |
3017 | (list 'cons ''macro code) | |
3018 | (list 'quote (cons 'macro (eval code)))))) | |
3019 | (list 'quote (nth 1 form))))) | |
3020 | ||
3021 | (defun byte-compile-defvar (form) | |
3022 | ;; This is not used for file-level defvar/consts with doc strings. | |
3023 | (let ((var (nth 1 form)) | |
3024 | (value (nth 2 form)) | |
3025 | (string (nth 3 form))) | |
3026 | (if (memq 'free-vars byte-compile-warnings) | |
3027 | (setq byte-compile-bound-variables | |
3028 | (cons var byte-compile-bound-variables))) | |
3029 | (byte-compile-body-do-effect | |
3030 | (list (if (cdr (cdr form)) | |
3031 | (if (eq (car form) 'defconst) | |
3032 | (list 'setq var value) | |
3033 | (list 'or (list 'boundp (list 'quote var)) | |
3034 | (list 'setq var value)))) | |
3e6eef95 RS |
3035 | ;; Put the defined variable in this library's load-history entry |
3036 | ;; just as a real defvar would. | |
3037 | (list 'setq 'current-load-list | |
3038 | (list 'cons (list 'quote var) | |
3039 | 'current-load-list)) | |
1c393159 JB |
3040 | (if string |
3041 | (list 'put (list 'quote var) ''variable-documentation string)) | |
3042 | (list 'quote var))))) | |
3043 | ||
3044 | (defun byte-compile-autoload (form) | |
3045 | (and (byte-compile-constp (nth 1 form)) | |
3046 | (byte-compile-constp (nth 5 form)) | |
3047 | (eval (nth 5 form)) ; macro-p | |
3048 | (not (fboundp (eval (nth 1 form)))) | |
3049 | (byte-compile-warn | |
3050 | "The compiler ignores `autoload' except at top level. You should | |
3051 | probably put the autoload of the macro `%s' at top-level." | |
3052 | (eval (nth 1 form)))) | |
3053 | (byte-compile-normal-call form)) | |
3054 | ||
3055 | ;; Lambda's in valid places are handled as special cases by various code. | |
3056 | ;; The ones that remain are errors. | |
3057 | (defun byte-compile-lambda-form (form) | |
3058 | (error "`lambda' used as function name is invalid")) | |
3059 | ||
5286a842 RS |
3060 | ;; Compile normally, but deal with warnings for the function being defined. |
3061 | (defun byte-compile-defalias (form) | |
3062 | (if (and (consp (cdr form)) (consp (nth 1 form)) | |
3063 | (eq (car (nth 1 form)) 'quote) | |
3064 | (consp (cdr (nth 1 form))) | |
3065 | (symbolp (nth 1 (nth 1 form))) | |
3066 | (consp (nthcdr 2 form)) | |
3067 | (consp (nth 2 form)) | |
3068 | (eq (car (nth 2 form)) 'quote) | |
3069 | (consp (cdr (nth 2 form))) | |
3070 | (symbolp (nth 1 (nth 2 form)))) | |
3071 | (progn | |
3072 | (byte-compile-defalias-warn (nth 1 (nth 1 form)) | |
3073 | (nth 1 (nth 2 form))) | |
3074 | (setq byte-compile-function-environment | |
3075 | (cons (cons (nth 1 (nth 1 form)) | |
3076 | (nth 1 (nth 2 form))) | |
3077 | byte-compile-function-environment)))) | |
b3848c28 | 3078 | (byte-compile-normal-call form)) |
5286a842 RS |
3079 | |
3080 | ;; Turn off warnings about prior calls to the function being defalias'd. | |
3081 | ;; This could be smarter and compare those calls with | |
3082 | ;; the function it is being aliased to. | |
3083 | (defun byte-compile-defalias-warn (new alias) | |
3084 | (let ((calls (assq new byte-compile-unresolved-functions))) | |
3085 | (if calls | |
3086 | (setq byte-compile-unresolved-functions | |
3087 | (delq calls byte-compile-unresolved-functions))))) | |
1c393159 JB |
3088 | \f |
3089 | ;;; tags | |
3090 | ||
3091 | ;; Note: Most operations will strip off the 'TAG, but it speeds up | |
3092 | ;; optimization to have the 'TAG as a part of the tag. | |
3093 | ;; Tags will be (TAG . (tag-number . stack-depth)). | |
3094 | (defun byte-compile-make-tag () | |
3095 | (list 'TAG (setq byte-compile-tag-number (1+ byte-compile-tag-number)))) | |
3096 | ||
3097 | ||
3098 | (defun byte-compile-out-tag (tag) | |
3099 | (setq byte-compile-output (cons tag byte-compile-output)) | |
3100 | (if (cdr (cdr tag)) | |
3101 | (progn | |
3102 | ;; ## remove this someday | |
3103 | (and byte-compile-depth | |
3104 | (not (= (cdr (cdr tag)) byte-compile-depth)) | |
52799cb8 | 3105 | (error "Compiler bug: depth conflict at tag %d" (car (cdr tag)))) |
1c393159 JB |
3106 | (setq byte-compile-depth (cdr (cdr tag)))) |
3107 | (setcdr (cdr tag) byte-compile-depth))) | |
3108 | ||
3109 | (defun byte-compile-goto (opcode tag) | |
3110 | (setq byte-compile-output (cons (cons opcode tag) byte-compile-output)) | |
3111 | (setcdr (cdr tag) (if (memq opcode byte-goto-always-pop-ops) | |
3112 | (1- byte-compile-depth) | |
3113 | byte-compile-depth)) | |
3114 | (setq byte-compile-depth (and (not (eq opcode 'byte-goto)) | |
3115 | (1- byte-compile-depth)))) | |
3116 | ||
3117 | (defun byte-compile-out (opcode offset) | |
3118 | (setq byte-compile-output (cons (cons opcode offset) byte-compile-output)) | |
3119 | (cond ((eq opcode 'byte-call) | |
3120 | (setq byte-compile-depth (- byte-compile-depth offset))) | |
3121 | ((eq opcode 'byte-return) | |
3122 | ;; This is actually an unnecessary case, because there should be | |
3123 | ;; no more opcodes behind byte-return. | |
3124 | (setq byte-compile-depth nil)) | |
3125 | (t | |
3126 | (setq byte-compile-depth (+ byte-compile-depth | |
3127 | (or (aref byte-stack+-info | |
3128 | (symbol-value opcode)) | |
3129 | (- (1- offset)))) | |
3130 | byte-compile-maxdepth (max byte-compile-depth | |
3131 | byte-compile-maxdepth)))) | |
52799cb8 | 3132 | ;;(if (< byte-compile-depth 0) (error "Compiler error: stack underflow")) |
1c393159 JB |
3133 | ) |
3134 | ||
3135 | \f | |
3136 | ;;; call tree stuff | |
3137 | ||
3138 | (defun byte-compile-annotate-call-tree (form) | |
3139 | (let (entry) | |
3140 | ;; annotate the current call | |
3141 | (if (setq entry (assq (car form) byte-compile-call-tree)) | |
3142 | (or (memq byte-compile-current-form (nth 1 entry)) ;callers | |
3143 | (setcar (cdr entry) | |
3144 | (cons byte-compile-current-form (nth 1 entry)))) | |
3145 | (setq byte-compile-call-tree | |
3146 | (cons (list (car form) (list byte-compile-current-form) nil) | |
3147 | byte-compile-call-tree))) | |
3148 | ;; annotate the current function | |
3149 | (if (setq entry (assq byte-compile-current-form byte-compile-call-tree)) | |
3150 | (or (memq (car form) (nth 2 entry)) ;called | |
3151 | (setcar (cdr (cdr entry)) | |
3152 | (cons (car form) (nth 2 entry)))) | |
3153 | (setq byte-compile-call-tree | |
3154 | (cons (list byte-compile-current-form nil (list (car form))) | |
3155 | byte-compile-call-tree))) | |
3156 | )) | |
3157 | ||
52799cb8 RS |
3158 | ;; Renamed from byte-compile-report-call-tree |
3159 | ;; to avoid interfering with completion of byte-compile-file. | |
fd5285f3 | 3160 | ;;;###autoload |
52799cb8 RS |
3161 | (defun display-call-tree (&optional filename) |
3162 | "Display a call graph of a specified file. | |
3163 | This lists which functions have been called, what functions called | |
3164 | them, and what functions they call. The list includes all functions | |
3165 | whose definitions have been compiled in this Emacs session, as well as | |
3166 | all functions called by those functions. | |
1c393159 | 3167 | |
52799cb8 RS |
3168 | The call graph does not include macros, inline functions, or |
3169 | primitives that the byte-code interpreter knows about directly \(eq, | |
3170 | cons, etc.\). | |
1c393159 JB |
3171 | |
3172 | The call tree also lists those functions which are not known to be called | |
52799cb8 RS |
3173 | \(that is, to which no calls have been compiled\), and which cannot be |
3174 | invoked interactively." | |
1c393159 JB |
3175 | (interactive) |
3176 | (message "Generating call tree...") | |
3177 | (with-output-to-temp-buffer "*Call-Tree*" | |
3178 | (set-buffer "*Call-Tree*") | |
3179 | (erase-buffer) | |
47cf9d3a | 3180 | (message "Generating call tree... (sorting on %s)" |
1c393159 JB |
3181 | byte-compile-call-tree-sort) |
3182 | (insert "Call tree for " | |
3183 | (cond ((null byte-compile-current-file) (or filename "???")) | |
3184 | ((stringp byte-compile-current-file) | |
3185 | byte-compile-current-file) | |
3186 | (t (buffer-name byte-compile-current-file))) | |
3187 | " sorted on " | |
3188 | (prin1-to-string byte-compile-call-tree-sort) | |
3189 | ":\n\n") | |
3190 | (if byte-compile-call-tree-sort | |
3191 | (setq byte-compile-call-tree | |
3192 | (sort byte-compile-call-tree | |
3193 | (cond ((eq byte-compile-call-tree-sort 'callers) | |
3194 | (function (lambda (x y) (< (length (nth 1 x)) | |
3195 | (length (nth 1 y)))))) | |
3196 | ((eq byte-compile-call-tree-sort 'calls) | |
3197 | (function (lambda (x y) (< (length (nth 2 x)) | |
3198 | (length (nth 2 y)))))) | |
3199 | ((eq byte-compile-call-tree-sort 'calls+callers) | |
3200 | (function (lambda (x y) (< (+ (length (nth 1 x)) | |
3201 | (length (nth 2 x))) | |
3202 | (+ (length (nth 1 y)) | |
3203 | (length (nth 2 y))))))) | |
3204 | ((eq byte-compile-call-tree-sort 'name) | |
3205 | (function (lambda (x y) (string< (car x) | |
3206 | (car y))))) | |
52799cb8 | 3207 | (t (error "`byte-compile-call-tree-sort': `%s' - unknown sort mode" |
1c393159 JB |
3208 | byte-compile-call-tree-sort)))))) |
3209 | (message "Generating call tree...") | |
3210 | (let ((rest byte-compile-call-tree) | |
3211 | (b (current-buffer)) | |
3212 | f p | |
3213 | callers calls) | |
3214 | (while rest | |
3215 | (prin1 (car (car rest)) b) | |
3216 | (setq callers (nth 1 (car rest)) | |
3217 | calls (nth 2 (car rest))) | |
3218 | (insert "\t" | |
3219 | (cond ((not (fboundp (setq f (car (car rest))))) | |
3220 | (if (null f) | |
3221 | " <top level>";; shouldn't insert nil then, actually -sk | |
3222 | " <not defined>")) | |
3223 | ((subrp (setq f (symbol-function f))) | |
3224 | " <subr>") | |
3225 | ((symbolp f) | |
3226 | (format " ==> %s" f)) | |
ed015bdd | 3227 | ((byte-code-function-p f) |
1c393159 JB |
3228 | "<compiled function>") |
3229 | ((not (consp f)) | |
3230 | "<malformed function>") | |
3231 | ((eq 'macro (car f)) | |
ed015bdd | 3232 | (if (or (byte-code-function-p (cdr f)) |
1c393159 JB |
3233 | (assq 'byte-code (cdr (cdr (cdr f))))) |
3234 | " <compiled macro>" | |
3235 | " <macro>")) | |
3236 | ((assq 'byte-code (cdr (cdr f))) | |
3237 | "<compiled lambda>") | |
3238 | ((eq 'lambda (car f)) | |
3239 | "<function>") | |
3240 | (t "???")) | |
3241 | (format " (%d callers + %d calls = %d)" | |
3242 | ;; Does the optimizer eliminate common subexpressions?-sk | |
3243 | (length callers) | |
3244 | (length calls) | |
3245 | (+ (length callers) (length calls))) | |
3246 | "\n") | |
3247 | (if callers | |
3248 | (progn | |
3249 | (insert " called by:\n") | |
3250 | (setq p (point)) | |
3251 | (insert " " (if (car callers) | |
3252 | (mapconcat 'symbol-name callers ", ") | |
3253 | "<top level>")) | |
3254 | (let ((fill-prefix " ")) | |
3255 | (fill-region-as-paragraph p (point))))) | |
3256 | (if calls | |
3257 | (progn | |
3258 | (insert " calls:\n") | |
3259 | (setq p (point)) | |
3260 | (insert " " (mapconcat 'symbol-name calls ", ")) | |
3261 | (let ((fill-prefix " ")) | |
3262 | (fill-region-as-paragraph p (point))))) | |
3263 | (insert "\n") | |
3264 | (setq rest (cdr rest))) | |
3265 | ||
3266 | (message "Generating call tree...(finding uncalled functions...)") | |
3267 | (setq rest byte-compile-call-tree) | |
3268 | (let ((uncalled nil)) | |
3269 | (while rest | |
3270 | (or (nth 1 (car rest)) | |
3271 | (null (setq f (car (car rest)))) | |
3272 | (byte-compile-fdefinition f t) | |
3273 | (commandp (byte-compile-fdefinition f nil)) | |
3274 | (setq uncalled (cons f uncalled))) | |
3275 | (setq rest (cdr rest))) | |
3276 | (if uncalled | |
3277 | (let ((fill-prefix " ")) | |
3278 | (insert "Noninteractive functions not known to be called:\n ") | |
3279 | (setq p (point)) | |
3280 | (insert (mapconcat 'symbol-name (nreverse uncalled) ", ")) | |
3281 | (fill-region-as-paragraph p (point))))) | |
3282 | ) | |
3283 | (message "Generating call tree...done.") | |
3284 | )) | |
3285 | ||
3286 | \f | |
3287 | ;;; by crl@newton.purdue.edu | |
3288 | ;;; Only works noninteractively. | |
fd5285f3 | 3289 | ;;;###autoload |
1c393159 | 3290 | (defun batch-byte-compile () |
52799cb8 RS |
3291 | "Run `byte-compile-file' on the files remaining on the command line. |
3292 | Use this from the command line, with `-batch'; | |
3293 | it won't work in an interactive Emacs. | |
3294 | Each file is processed even if an error occurred previously. | |
1c393159 JB |
3295 | For example, invoke \"emacs -batch -f batch-byte-compile $emacs/ ~/*.el\"" |
3296 | ;; command-line-args-left is what is left of the command line (from startup.el) | |
3297 | (defvar command-line-args-left) ;Avoid 'free variable' warning | |
3298 | (if (not noninteractive) | |
52799cb8 | 3299 | (error "`batch-byte-compile' is to be used only with -batch")) |
1c393159 JB |
3300 | (let ((error nil)) |
3301 | (while command-line-args-left | |
3302 | (if (file-directory-p (expand-file-name (car command-line-args-left))) | |
3303 | (let ((files (directory-files (car command-line-args-left))) | |
3304 | source dest) | |
3305 | (while files | |
52799cb8 | 3306 | (if (and (string-match emacs-lisp-file-regexp (car files)) |
1c393159 JB |
3307 | (not (auto-save-file-name-p (car files))) |
3308 | (setq source (expand-file-name (car files) | |
3309 | (car command-line-args-left))) | |
3310 | (setq dest (byte-compile-dest-file source)) | |
3311 | (file-exists-p dest) | |
3312 | (file-newer-than-file-p source dest)) | |
3313 | (if (null (batch-byte-compile-file source)) | |
3314 | (setq error t))) | |
3315 | (setq files (cdr files)))) | |
3316 | (if (null (batch-byte-compile-file (car command-line-args-left))) | |
3317 | (setq error t))) | |
3318 | (setq command-line-args-left (cdr command-line-args-left))) | |
3319 | (message "Done") | |
3320 | (kill-emacs (if error 1 0)))) | |
3321 | ||
3322 | (defun batch-byte-compile-file (file) | |
3323 | (condition-case err | |
1c57117e | 3324 | (byte-compile-file file) |
1c393159 JB |
3325 | (error |
3326 | (message (if (cdr err) | |
3327 | ">>Error occurred processing %s: %s (%s)" | |
3328 | ">>Error occurred processing %s: %s") | |
3329 | file | |
3330 | (get (car err) 'error-message) | |
3331 | (prin1-to-string (cdr err))) | |
3332 | nil))) | |
3333 | ||
e9681c45 | 3334 | ;;;###autoload |
e27c3564 JB |
3335 | (defun batch-byte-recompile-directory () |
3336 | "Runs `byte-recompile-directory' on the dirs remaining on the command line. | |
79c6071d RS |
3337 | Must be used only with `-batch', and kills Emacs on completion. |
3338 | For example, invoke `emacs -batch -f batch-byte-recompile-directory .'." | |
e27c3564 JB |
3339 | ;; command-line-args-left is what is left of the command line (startup.el) |
3340 | (defvar command-line-args-left) ;Avoid 'free variable' warning | |
3341 | (if (not noninteractive) | |
3342 | (error "batch-byte-recompile-directory is to be used only with -batch")) | |
3343 | (or command-line-args-left | |
3344 | (setq command-line-args-left '("."))) | |
3345 | (while command-line-args-left | |
3346 | (byte-recompile-directory (car command-line-args-left)) | |
3347 | (setq command-line-args-left (cdr command-line-args-left))) | |
3348 | (kill-emacs 0)) | |
3349 | ||
1c393159 | 3350 | |
1c393159 JB |
3351 | (make-obsolete 'dot 'point) |
3352 | (make-obsolete 'dot-max 'point-max) | |
3353 | (make-obsolete 'dot-min 'point-min) | |
3354 | (make-obsolete 'dot-marker 'point-marker) | |
3355 | ||
52799cb8 RS |
3356 | (make-obsolete 'buffer-flush-undo 'buffer-disable-undo) |
3357 | (make-obsolete 'baud-rate "use the baud-rate variable instead") | |
ed015bdd | 3358 | (make-obsolete 'compiled-function-p 'byte-code-function-p) |
1814e5a9 | 3359 | (make-obsolete 'define-function 'defalias) |
9e2b097b JB |
3360 | (make-obsolete-variable 'auto-fill-hook 'auto-fill-function) |
3361 | (make-obsolete-variable 'blink-paren-hook 'blink-paren-function) | |
3362 | (make-obsolete-variable 'lisp-indent-hook 'lisp-indent-function) | |
3363 | (make-obsolete-variable 'temp-buffer-show-hook | |
3364 | 'temp-buffer-show-function) | |
3365 | (make-obsolete-variable 'inhibit-local-variables | |
5023d9a0 | 3366 | "use enable-local-variables (with the reversed sense).") |
79d52eea | 3367 | (make-obsolete-variable 'unread-command-char |
ed015bdd JB |
3368 | "use unread-command-events instead. That variable is a list of events to reread, so it now uses nil to mean `no event', instead of -1.") |
3369 | (make-obsolete-variable 'unread-command-event | |
591655c7 | 3370 | "use unread-command-events; which is a list of events rather than a single event.") |
f3341900 | 3371 | (make-obsolete-variable 'suspend-hooks 'suspend-hook) |
ec9a76e3 | 3372 | (make-obsolete-variable 'comment-indent-hook 'comment-indent-function) |
f3341900 | 3373 | (make-obsolete-variable 'meta-flag "Use the set-input-mode function instead.") |
591655c7 SM |
3374 | (make-obsolete-variable 'executing-macro 'executing-kbd-macro) |
3375 | (make-obsolete-variable 'before-change-function | |
3376 | "use before-change-functions; which is a list of functions rather than a single function.") | |
3377 | (make-obsolete-variable 'after-change-function | |
3378 | "use after-change-functions; which is a list of functions rather than a single function.") | |
3379 | (make-obsolete-variable 'font-lock-doc-string-face 'font-lock-string-face) | |
ed16b6f2 RS |
3380 | (make-obsolete-variable 'post-command-idle-hook |
3381 | "use timers instead, with `run-with-idle-timer'.") | |
3382 | (make-obsolete-variable 'post-command-idle-delay | |
3383 | "use timers instead, with `run-with-idle-timer'.") | |
1c393159 JB |
3384 | |
3385 | (provide 'byte-compile) | |
200503bb | 3386 | (provide 'bytecomp) |
1c393159 JB |
3387 | |
3388 | \f | |
3389 | ;;; report metering (see the hacks in bytecode.c) | |
3390 | ||
52799cb8 RS |
3391 | (defun byte-compile-report-ops () |
3392 | (defvar byte-code-meter) | |
3393 | (with-output-to-temp-buffer "*Meter*" | |
3394 | (set-buffer "*Meter*") | |
3395 | (let ((i 0) n op off) | |
3396 | (while (< i 256) | |
3397 | (setq n (aref (aref byte-code-meter 0) i) | |
3398 | off nil) | |
3399 | (if t ;(not (zerop n)) | |
3400 | (progn | |
3401 | (setq op i) | |
3402 | (setq off nil) | |
3403 | (cond ((< op byte-nth) | |
3404 | (setq off (logand op 7)) | |
3405 | (setq op (logand op 248))) | |
3406 | ((>= op byte-constant) | |
3407 | (setq off (- op byte-constant) | |
3408 | op byte-constant))) | |
3409 | (setq op (aref byte-code-vector op)) | |
3410 | (insert (format "%-4d" i)) | |
3411 | (insert (symbol-name op)) | |
3412 | (if off (insert " [" (int-to-string off) "]")) | |
3413 | (indent-to 40) | |
3414 | (insert (int-to-string n) "\n"))) | |
3415 | (setq i (1+ i)))))) | |
1c393159 JB |
3416 | \f |
3417 | ;; To avoid "lisp nesting exceeds max-lisp-eval-depth" when bytecomp compiles | |
3418 | ;; itself, compile some of its most used recursive functions (at load time). | |
3419 | ;; | |
3420 | (eval-when-compile | |
591655c7 SM |
3421 | (or (byte-code-function-p (symbol-function 'byte-compile-form)) |
3422 | (assq 'byte-code (symbol-function 'byte-compile-form)) | |
3423 | (let ((byte-optimize nil) ; do it fast | |
3424 | (byte-compile-warnings nil)) | |
3425 | (mapcar '(lambda (x) | |
3426 | (or noninteractive (message "compiling %s..." x)) | |
3427 | (byte-compile x) | |
3428 | (or noninteractive (message "compiling %s...done" x))) | |
3429 | '(byte-compile-normal-call | |
3430 | byte-compile-form | |
3431 | byte-compile-body | |
3432 | ;; Inserted some more than necessary, to speed it up. | |
3433 | byte-compile-top-level | |
3434 | byte-compile-out-toplevel | |
3435 | byte-compile-constant | |
3436 | byte-compile-variable-ref)))) | |
3437 | nil) | |
fd5285f3 RS |
3438 | |
3439 | ;;; bytecomp.el ends here |