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