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