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