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