]> code.delx.au - gnu-emacs/blob - lisp/emacs-lisp/bytecomp.el
Merge changes from emacs-23 branch.
[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, 2000, 2001, 2002,
4 ;; 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010
5 ;; Free Software Foundation, Inc.
6
7 ;; Author: Jamie Zawinski <jwz@lucid.com>
8 ;; Hallvard Furuseth <hbf@ulrik.uio.no>
9 ;; Maintainer: FSF
10 ;; Keywords: lisp
11 ;; Package: emacs
12
13 ;; This file is part of GNU Emacs.
14
15 ;; GNU Emacs is free software: you can redistribute it and/or modify
16 ;; it under the terms of the GNU General Public License as published by
17 ;; the Free Software Foundation, either version 3 of the License, or
18 ;; (at your option) any later version.
19
20 ;; GNU Emacs is distributed in the hope that it will be useful,
21 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
22 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
23 ;; GNU General Public License for more details.
24
25 ;; You should have received a copy of the GNU General Public License
26 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
27
28 ;;; Commentary:
29
30 ;; The Emacs Lisp byte compiler. This crunches lisp source into a sort
31 ;; of p-code (`lapcode') which takes up less space and can be interpreted
32 ;; faster. [`LAP' == `Lisp Assembly Program'.]
33 ;; The user entry points are byte-compile-file and byte-recompile-directory.
34
35 ;;; Code:
36
37 ;; ========================================================================
38 ;; Entry points:
39 ;; byte-recompile-directory, byte-compile-file,
40 ;; batch-byte-compile, batch-byte-recompile-directory,
41 ;; byte-compile, compile-defun,
42 ;; display-call-tree
43 ;; (byte-compile-buffer and byte-compile-and-load-file were turned off
44 ;; because they are not terribly useful and get in the way of completion.)
45
46 ;; This version of the byte compiler has the following improvements:
47 ;; + optimization of compiled code:
48 ;; - removal of unreachable code;
49 ;; - removal of calls to side-effectless functions whose return-value
50 ;; is unused;
51 ;; - compile-time evaluation of safe constant forms, such as (consp nil)
52 ;; and (ash 1 6);
53 ;; - open-coding of literal lambdas;
54 ;; - peephole optimization of emitted code;
55 ;; - trivial functions are left uncompiled for speed.
56 ;; + support for inline functions;
57 ;; + compile-time evaluation of arbitrary expressions;
58 ;; + compile-time warning messages for:
59 ;; - functions being redefined with incompatible arglists;
60 ;; - functions being redefined as macros, or vice-versa;
61 ;; - functions or macros defined multiple times in the same file;
62 ;; - functions being called with the incorrect number of arguments;
63 ;; - functions being called which are not defined globally, in the
64 ;; file, or as autoloads;
65 ;; - assignment and reference of undeclared free variables;
66 ;; - various syntax errors;
67 ;; + correct compilation of nested defuns, defmacros, defvars and defsubsts;
68 ;; + correct compilation of top-level uses of macros;
69 ;; + the ability to generate a histogram of functions called.
70
71 ;; User customization variables: M-x customize-group bytecomp
72
73 ;; New Features:
74 ;;
75 ;; o The form `defsubst' is just like `defun', except that the function
76 ;; generated will be open-coded in compiled code which uses it. This
77 ;; means that no function call will be generated, it will simply be
78 ;; spliced in. Lisp functions calls are very slow, so this can be a
79 ;; big win.
80 ;;
81 ;; You can generally accomplish the same thing with `defmacro', but in
82 ;; that case, the defined procedure can't be used as an argument to
83 ;; mapcar, etc.
84 ;;
85 ;; o You can also open-code one particular call to a function without
86 ;; open-coding all calls. Use the 'inline' form to do this, like so:
87 ;;
88 ;; (inline (foo 1 2 3)) ;; `foo' will be open-coded
89 ;; or...
90 ;; (inline ;; `foo' and `baz' will be
91 ;; (foo 1 2 3 (bar 5)) ;; open-coded, but `bar' will not.
92 ;; (baz 0))
93 ;;
94 ;; o It is possible to open-code a function in the same file it is defined
95 ;; in without having to load that file before compiling it. The
96 ;; byte-compiler has been modified to remember function definitions in
97 ;; the compilation environment in the same way that it remembers macro
98 ;; definitions.
99 ;;
100 ;; o Forms like ((lambda ...) ...) are open-coded.
101 ;;
102 ;; o The form `eval-when-compile' is like progn, except that the body
103 ;; is evaluated at compile-time. When it appears at top-level, this
104 ;; is analogous to the Common Lisp idiom (eval-when (compile) ...).
105 ;; When it does not appear at top-level, it is similar to the
106 ;; Common Lisp #. reader macro (but not in interpreted code).
107 ;;
108 ;; o The form `eval-and-compile' is similar to eval-when-compile, but
109 ;; the whole form is evalled both at compile-time and at run-time.
110 ;;
111 ;; o The command compile-defun is analogous to eval-defun.
112 ;;
113 ;; o If you run byte-compile-file on a filename which is visited in a
114 ;; buffer, and that buffer is modified, you are asked whether you want
115 ;; to save the buffer before compiling.
116 ;;
117 ;; o byte-compiled files now start with the string `;ELC'.
118 ;; Some versions of `file' can be customized to recognize that.
119
120 (require 'backquote)
121 (eval-when-compile (require 'cl))
122
123 (or (fboundp 'defsubst)
124 ;; This really ought to be loaded already!
125 (load "byte-run"))
126
127 (defgroup bytecomp nil
128 "Emacs Lisp byte-compiler."
129 :group 'lisp)
130
131 (defcustom emacs-lisp-file-regexp "\\.el\\'"
132 "Regexp which matches Emacs Lisp source files.
133 If you change this, you might want to set `byte-compile-dest-file-function'."
134 :group 'bytecomp
135 :type 'regexp)
136
137 (defcustom byte-compile-dest-file-function nil
138 "Function for the function `byte-compile-dest-file' to call.
139 It should take one argument, the name of an Emacs Lisp source
140 file name, and return the name of the compiled file."
141 :group 'bytecomp
142 :type '(choice (const nil) function)
143 :version "23.2")
144
145 ;; This enables file name handlers such as jka-compr
146 ;; to remove parts of the file name that should not be copied
147 ;; through to the output file name.
148 (defun byte-compiler-base-file-name (filename)
149 (let ((handler (find-file-name-handler filename
150 'byte-compiler-base-file-name)))
151 (if handler
152 (funcall handler 'byte-compiler-base-file-name filename)
153 filename)))
154
155 (or (fboundp 'byte-compile-dest-file)
156 ;; The user may want to redefine this along with emacs-lisp-file-regexp,
157 ;; so only define it if it is undefined.
158 ;; Note - redefining this function is obsolete as of 23.2.
159 ;; Customize byte-compile-dest-file-function instead.
160 (defun byte-compile-dest-file (filename)
161 "Convert an Emacs Lisp source file name to a compiled file name.
162 If `byte-compile-dest-file-function' is non-nil, uses that
163 function to do the work. Otherwise, if FILENAME matches
164 `emacs-lisp-file-regexp' (by default, files with the extension `.el'),
165 adds `c' to it; otherwise adds `.elc'."
166 (if byte-compile-dest-file-function
167 (funcall byte-compile-dest-file-function filename)
168 (setq filename (file-name-sans-versions
169 (byte-compiler-base-file-name filename)))
170 (cond ((string-match emacs-lisp-file-regexp filename)
171 (concat (substring filename 0 (match-beginning 0)) ".elc"))
172 (t (concat filename ".elc"))))))
173
174 ;; This can be the 'byte-compile property of any symbol.
175 (autoload 'byte-compile-inline-expand "byte-opt")
176
177 ;; This is the entrypoint to the lapcode optimizer pass1.
178 (autoload 'byte-optimize-form "byte-opt")
179 ;; This is the entrypoint to the lapcode optimizer pass2.
180 (autoload 'byte-optimize-lapcode "byte-opt")
181 (autoload 'byte-compile-unfold-lambda "byte-opt")
182
183 ;; This is the entry point to the decompiler, which is used by the
184 ;; disassembler. The disassembler just requires 'byte-compile, but
185 ;; that doesn't define this function, so this seems to be a reasonable
186 ;; thing to do.
187 (autoload 'byte-decompile-bytecode "byte-opt")
188
189 (defcustom byte-compile-verbose
190 (and (not noninteractive) (> baud-rate search-slow-speed))
191 "Non-nil means print messages describing progress of byte-compiler."
192 :group 'bytecomp
193 :type 'boolean)
194
195 (defcustom byte-optimize t
196 "Enable optimization in the byte compiler.
197 Possible values are:
198 nil - no optimization
199 t - all optimizations
200 `source' - source-level optimizations only
201 `byte' - code-level optimizations only"
202 :group 'bytecomp
203 :type '(choice (const :tag "none" nil)
204 (const :tag "all" t)
205 (const :tag "source-level" source)
206 (const :tag "byte-level" byte)))
207
208 (defcustom byte-compile-delete-errors nil
209 "If non-nil, the optimizer may delete forms that may signal an error.
210 This includes variable references and calls to functions such as `car'."
211 :group 'bytecomp
212 :type 'boolean)
213
214 (defvar byte-compile-dynamic nil
215 "If non-nil, compile function bodies so they load lazily.
216 They are hidden in comments in the compiled file,
217 and each one is brought into core when the
218 function is called.
219
220 To enable this option, make it a file-local variable
221 in the source file you want it to apply to.
222 For example, add -*-byte-compile-dynamic: t;-*- on the first line.
223
224 When this option is true, if you load the compiled file and then move it,
225 the functions you loaded will not be able to run.")
226 ;;;###autoload(put 'byte-compile-dynamic 'safe-local-variable 'booleanp)
227
228 (defvar byte-compile-disable-print-circle nil
229 "If non-nil, disable `print-circle' on printing a byte-compiled code.")
230 ;;;###autoload(put 'byte-compile-disable-print-circle 'safe-local-variable 'booleanp)
231
232 (defcustom byte-compile-dynamic-docstrings t
233 "If non-nil, compile doc strings for lazy access.
234 We bury the doc strings of functions and variables inside comments in
235 the file, and bring them into core only when they are actually needed.
236
237 When this option is true, if you load the compiled file and then move it,
238 you won't be able to find the documentation of anything in that file.
239
240 To disable this option for a certain file, make it a file-local variable
241 in the source file. For example, add this to the first line:
242 -*-byte-compile-dynamic-docstrings:nil;-*-
243 You can also set the variable globally.
244
245 This option is enabled by default because it reduces Emacs memory usage."
246 :group 'bytecomp
247 :type 'boolean)
248 ;;;###autoload(put 'byte-compile-dynamic-docstrings 'safe-local-variable 'booleanp)
249
250 (defcustom byte-optimize-log nil
251 "If true, the byte-compiler will log its optimizations into *Compile-Log*.
252 If this is 'source, then only source-level optimizations will be logged.
253 If it is 'byte, then only byte-level optimizations will be logged."
254 :group 'bytecomp
255 :type '(choice (const :tag "none" nil)
256 (const :tag "all" t)
257 (const :tag "source-level" source)
258 (const :tag "byte-level" byte)))
259
260 (defcustom byte-compile-error-on-warn nil
261 "If true, the byte-compiler reports warnings with `error'."
262 :group 'bytecomp
263 :type 'boolean)
264
265 (defconst byte-compile-warning-types
266 '(redefine callargs free-vars unresolved
267 obsolete noruntime cl-functions interactive-only
268 make-local mapcar constants suspicious lexical)
269 "The list of warning types used when `byte-compile-warnings' is t.")
270 (defcustom byte-compile-warnings t
271 "List of warnings that the byte-compiler should issue (t for all).
272
273 Elements of the list may be:
274
275 free-vars references to variables not in the current lexical scope.
276 unresolved calls to unknown functions.
277 callargs function calls with args that don't match the definition.
278 redefine function name redefined from a macro to ordinary function or vice
279 versa, or redefined to take a different number of arguments.
280 obsolete obsolete variables and functions.
281 noruntime functions that may not be defined at runtime (typically
282 defined only under `eval-when-compile').
283 cl-functions calls to runtime functions from the CL package (as
284 distinguished from macros and aliases).
285 interactive-only
286 commands that normally shouldn't be called from Lisp code.
287 make-local calls to make-variable-buffer-local that may be incorrect.
288 mapcar mapcar called for effect.
289 constants let-binding of, or assignment to, constants/nonvariables.
290 suspicious constructs that usually don't do what the coder wanted.
291
292 If the list begins with `not', then the remaining elements specify warnings to
293 suppress. For example, (not mapcar) will suppress warnings about mapcar."
294 :group 'bytecomp
295 :type `(choice (const :tag "All" t)
296 (set :menu-tag "Some"
297 ,@(mapcar (lambda (x) `(const ,x))
298 byte-compile-warning-types))))
299 ;;;###autoload(put 'byte-compile-warnings 'safe-local-variable 'byte-compile-warnings-safe-p)
300
301 ;;;###autoload
302 (defun byte-compile-warnings-safe-p (x)
303 "Return non-nil if X is valid as a value of `byte-compile-warnings'."
304 (or (booleanp x)
305 (and (listp x)
306 (if (eq (car x) 'not) (setq x (cdr x))
307 t)
308 (equal (mapcar
309 (lambda (e)
310 (when (memq e byte-compile-warning-types)
311 e))
312 x)
313 x))))
314
315 (defun byte-compile-warning-enabled-p (warning)
316 "Return non-nil if WARNING is enabled, according to `byte-compile-warnings'."
317 (or (eq byte-compile-warnings t)
318 (if (eq (car byte-compile-warnings) 'not)
319 (not (memq warning byte-compile-warnings))
320 (memq warning byte-compile-warnings))))
321
322 ;;;###autoload
323 (defun byte-compile-disable-warning (warning)
324 "Change `byte-compile-warnings' to disable WARNING.
325 If `byte-compile-warnings' is t, set it to `(not WARNING)'.
326 Otherwise, if the first element is `not', add WARNING, else remove it.
327 Normally you should let-bind `byte-compile-warnings' before calling this,
328 else the global value will be modified."
329 (setq byte-compile-warnings
330 (cond ((eq byte-compile-warnings t)
331 (list 'not warning))
332 ((eq (car byte-compile-warnings) 'not)
333 (if (memq warning byte-compile-warnings)
334 byte-compile-warnings
335 (append byte-compile-warnings (list warning))))
336 (t
337 (delq warning byte-compile-warnings)))))
338
339 ;;;###autoload
340 (defun byte-compile-enable-warning (warning)
341 "Change `byte-compile-warnings' to enable WARNING.
342 If `byte-compile-warnings' is `t', do nothing. Otherwise, if the
343 first element is `not', remove WARNING, else add it.
344 Normally you should let-bind `byte-compile-warnings' before calling this,
345 else the global value will be modified."
346 (or (eq byte-compile-warnings t)
347 (setq byte-compile-warnings
348 (cond ((eq (car byte-compile-warnings) 'not)
349 (delq warning byte-compile-warnings))
350 ((memq warning byte-compile-warnings)
351 byte-compile-warnings)
352 (t
353 (append byte-compile-warnings (list warning)))))))
354
355 (defvar byte-compile-interactive-only-functions
356 '(beginning-of-buffer end-of-buffer replace-string replace-regexp
357 insert-file insert-buffer insert-file-literally previous-line next-line
358 goto-line comint-run delete-backward-char)
359 "List of commands that are not meant to be called from Lisp.")
360
361 (defvar byte-compile-not-obsolete-vars nil
362 "If non-nil, a list of variables that shouldn't be reported as obsolete.")
363
364 (defvar byte-compile-not-obsolete-funcs nil
365 "If non-nil, a list of functions that shouldn't be reported as obsolete.")
366
367 (defcustom byte-compile-generate-call-tree nil
368 "Non-nil means collect call-graph information when compiling.
369 This records which functions were called and from where.
370 If the value is t, compilation displays the call graph when it finishes.
371 If the value is neither t nor nil, compilation asks you whether to display
372 the graph.
373
374 The call tree only lists functions called, not macros used. Those functions
375 which the byte-code interpreter knows about directly (eq, cons, etc.) are
376 not reported.
377
378 The call tree also lists those functions which are not known to be called
379 \(that is, to which no calls have been compiled). Functions which can be
380 invoked interactively are excluded from this list."
381 :group 'bytecomp
382 :type '(choice (const :tag "Yes" t) (const :tag "No" nil)
383 (other :tag "Ask" lambda)))
384
385 (defvar byte-compile-call-tree nil
386 "Alist of functions and their call tree.
387 Each element looks like
388
389 \(FUNCTION CALLERS CALLS\)
390
391 where CALLERS is a list of functions that call FUNCTION, and CALLS
392 is a list of functions for which calls were generated while compiling
393 FUNCTION.")
394
395 (defcustom byte-compile-call-tree-sort 'name
396 "If non-nil, sort the call tree.
397 The values `name', `callers', `calls', `calls+callers'
398 specify different fields to sort on."
399 :group 'bytecomp
400 :type '(choice (const name) (const callers) (const calls)
401 (const calls+callers) (const nil)))
402
403 (defvar byte-compile-debug nil)
404 (defvar byte-compile-constants nil
405 "List of all constants encountered during compilation of this form.")
406 (defvar byte-compile-variables nil
407 "List of all variables encountered during compilation of this form.")
408 (defvar byte-compile-bound-variables nil
409 "List of variables bound in the context of the current form.
410 This list lives partly on the stack.")
411 (defvar byte-compile-const-variables nil
412 "List of variables declared as constants during compilation of this file.")
413 (defvar byte-compile-free-references)
414 (defvar byte-compile-free-assignments)
415
416 (defvar byte-compiler-error-flag)
417
418 (defconst byte-compile-initial-macro-environment
419 '(
420 ;; (byte-compiler-options . (lambda (&rest forms)
421 ;; (apply 'byte-compiler-options-handler forms)))
422 (eval-when-compile . (lambda (&rest body)
423 (list 'quote
424 (byte-compile-eval (byte-compile-top-level
425 (cons 'progn body))))))
426 (eval-and-compile . (lambda (&rest body)
427 (byte-compile-eval-before-compile (cons 'progn body))
428 (cons 'progn body))))
429 "The default macro-environment passed to macroexpand by the compiler.
430 Placing a macro here will cause a macro to have different semantics when
431 expanded by the compiler as when expanded by the interpreter.")
432
433 (defvar byte-compile-macro-environment byte-compile-initial-macro-environment
434 "Alist of macros defined in the file being compiled.
435 Each element looks like (MACRONAME . DEFINITION). It is
436 \(MACRONAME . nil) when a macro is redefined as a function.")
437
438 (defvar byte-compile-function-environment nil
439 "Alist of functions defined in the file being compiled.
440 This is so we can inline them when necessary.
441 Each element looks like (FUNCTIONNAME . DEFINITION). It is
442 \(FUNCTIONNAME . nil) when a function is redefined as a macro.
443 It is \(FUNCTIONNAME . t) when all we know is that it was defined,
444 and we don't know the definition. For an autoloaded function, DEFINITION
445 has the form (autoload . FILENAME).")
446
447 (defvar byte-compile-unresolved-functions nil
448 "Alist of undefined functions to which calls have been compiled.
449 This variable is only significant whilst compiling an entire buffer.
450 Used for warnings when a function is not known to be defined or is later
451 defined with incorrect args.")
452
453 (defvar byte-compile-noruntime-functions nil
454 "Alist of functions called that may not be defined when the compiled code is run.
455 Used for warnings about calling a function that is defined during compilation
456 but won't necessarily be defined when the compiled file is loaded.")
457
458 (defvar byte-compile-tag-number 0)
459 (defvar byte-compile-output nil
460 "Alist describing contents to put in byte code string.
461 Each element is (INDEX . VALUE)")
462 (defvar byte-compile-depth 0 "Current depth of execution stack.")
463 (defvar byte-compile-maxdepth 0 "Maximum depth of execution stack.")
464
465 \f
466 ;;; The byte codes; this information is duplicated in bytecomp.c
467
468 (defvar byte-code-vector nil
469 "An array containing byte-code names indexed by byte-code values.")
470
471 (defvar byte-stack+-info nil
472 "An array with the stack adjustment for each byte-code.")
473
474 (defmacro byte-defop (opcode stack-adjust opname &optional docstring)
475 ;; This is a speed-hack for building the byte-code-vector at compile-time.
476 ;; We fill in the vector at macroexpand-time, and then after the last call
477 ;; to byte-defop, we write the vector out as a constant instead of writing
478 ;; out a bunch of calls to aset.
479 ;; Actually, we don't fill in the vector itself, because that could make
480 ;; it problematic to compile big changes to this compiler; we store the
481 ;; values on its plist, and remove them later in -extrude.
482 (let ((v1 (or (get 'byte-code-vector 'tmp-compile-time-value)
483 (put 'byte-code-vector 'tmp-compile-time-value
484 (make-vector 256 nil))))
485 (v2 (or (get 'byte-stack+-info 'tmp-compile-time-value)
486 (put 'byte-stack+-info 'tmp-compile-time-value
487 (make-vector 256 nil)))))
488 (aset v1 opcode opname)
489 (aset v2 opcode stack-adjust))
490 (if docstring
491 (list 'defconst opname opcode (concat "Byte code opcode " docstring "."))
492 (list 'defconst opname opcode)))
493
494 (defmacro byte-extrude-byte-code-vectors ()
495 (prog1 (list 'setq 'byte-code-vector
496 (get 'byte-code-vector 'tmp-compile-time-value)
497 'byte-stack+-info
498 (get 'byte-stack+-info 'tmp-compile-time-value))
499 (put 'byte-code-vector 'tmp-compile-time-value nil)
500 (put 'byte-stack+-info 'tmp-compile-time-value nil)))
501
502
503 ;; unused: 0-7
504
505 ;; These opcodes are special in that they pack their argument into the
506 ;; opcode word.
507 ;;
508 (byte-defop 8 1 byte-varref "for variable reference")
509 (byte-defop 16 -1 byte-varset "for setting a variable")
510 (byte-defop 24 -1 byte-varbind "for binding a variable")
511 (byte-defop 32 0 byte-call "for calling a function")
512 (byte-defop 40 0 byte-unbind "for unbinding special bindings")
513 ;; codes 8-47 are consumed by the preceding opcodes
514
515 ;; unused: 48-55
516
517 (byte-defop 56 -1 byte-nth)
518 (byte-defop 57 0 byte-symbolp)
519 (byte-defop 58 0 byte-consp)
520 (byte-defop 59 0 byte-stringp)
521 (byte-defop 60 0 byte-listp)
522 (byte-defop 61 -1 byte-eq)
523 (byte-defop 62 -1 byte-memq)
524 (byte-defop 63 0 byte-not)
525 (byte-defop 64 0 byte-car)
526 (byte-defop 65 0 byte-cdr)
527 (byte-defop 66 -1 byte-cons)
528 (byte-defop 67 0 byte-list1)
529 (byte-defop 68 -1 byte-list2)
530 (byte-defop 69 -2 byte-list3)
531 (byte-defop 70 -3 byte-list4)
532 (byte-defop 71 0 byte-length)
533 (byte-defop 72 -1 byte-aref)
534 (byte-defop 73 -2 byte-aset)
535 (byte-defop 74 0 byte-symbol-value)
536 (byte-defop 75 0 byte-symbol-function) ; this was commented out
537 (byte-defop 76 -1 byte-set)
538 (byte-defop 77 -1 byte-fset) ; this was commented out
539 (byte-defop 78 -1 byte-get)
540 (byte-defop 79 -2 byte-substring)
541 (byte-defop 80 -1 byte-concat2)
542 (byte-defop 81 -2 byte-concat3)
543 (byte-defop 82 -3 byte-concat4)
544 (byte-defop 83 0 byte-sub1)
545 (byte-defop 84 0 byte-add1)
546 (byte-defop 85 -1 byte-eqlsign)
547 (byte-defop 86 -1 byte-gtr)
548 (byte-defop 87 -1 byte-lss)
549 (byte-defop 88 -1 byte-leq)
550 (byte-defop 89 -1 byte-geq)
551 (byte-defop 90 -1 byte-diff)
552 (byte-defop 91 0 byte-negate)
553 (byte-defop 92 -1 byte-plus)
554 (byte-defop 93 -1 byte-max)
555 (byte-defop 94 -1 byte-min)
556 (byte-defop 95 -1 byte-mult) ; v19 only
557 (byte-defop 96 1 byte-point)
558 (byte-defop 98 0 byte-goto-char)
559 (byte-defop 99 0 byte-insert)
560 (byte-defop 100 1 byte-point-max)
561 (byte-defop 101 1 byte-point-min)
562 (byte-defop 102 0 byte-char-after)
563 (byte-defop 103 1 byte-following-char)
564 (byte-defop 104 1 byte-preceding-char)
565 (byte-defop 105 1 byte-current-column)
566 (byte-defop 106 0 byte-indent-to)
567 (byte-defop 107 0 byte-scan-buffer-OBSOLETE) ; no longer generated as of v18
568 (byte-defop 108 1 byte-eolp)
569 (byte-defop 109 1 byte-eobp)
570 (byte-defop 110 1 byte-bolp)
571 (byte-defop 111 1 byte-bobp)
572 (byte-defop 112 1 byte-current-buffer)
573 (byte-defop 113 0 byte-set-buffer)
574 (byte-defop 114 0 byte-save-current-buffer
575 "To make a binding to record the current buffer")
576 (byte-defop 115 0 byte-set-mark-OBSOLETE)
577 (byte-defop 116 1 byte-interactive-p)
578
579 ;; These ops are new to v19
580 (byte-defop 117 0 byte-forward-char)
581 (byte-defop 118 0 byte-forward-word)
582 (byte-defop 119 -1 byte-skip-chars-forward)
583 (byte-defop 120 -1 byte-skip-chars-backward)
584 (byte-defop 121 0 byte-forward-line)
585 (byte-defop 122 0 byte-char-syntax)
586 (byte-defop 123 -1 byte-buffer-substring)
587 (byte-defop 124 -1 byte-delete-region)
588 (byte-defop 125 -1 byte-narrow-to-region)
589 (byte-defop 126 1 byte-widen)
590 (byte-defop 127 0 byte-end-of-line)
591
592 ;; unused: 128
593
594 ;; These store their argument in the next two bytes
595 (byte-defop 129 1 byte-constant2
596 "for reference to a constant with vector index >= byte-constant-limit")
597 (byte-defop 130 0 byte-goto "for unconditional jump")
598 (byte-defop 131 -1 byte-goto-if-nil "to pop value and jump if it's nil")
599 (byte-defop 132 -1 byte-goto-if-not-nil "to pop value and jump if it's not nil")
600 (byte-defop 133 -1 byte-goto-if-nil-else-pop
601 "to examine top-of-stack, jump and don't pop it if it's nil,
602 otherwise pop it")
603 (byte-defop 134 -1 byte-goto-if-not-nil-else-pop
604 "to examine top-of-stack, jump and don't pop it if it's non nil,
605 otherwise pop it")
606
607 (byte-defop 135 -1 byte-return "to pop a value and return it from `byte-code'")
608 (byte-defop 136 -1 byte-discard "to discard one value from stack")
609 (byte-defop 137 1 byte-dup "to duplicate the top of the stack")
610
611 (byte-defop 138 0 byte-save-excursion
612 "to make a binding to record the buffer, point and mark")
613 (byte-defop 139 0 byte-save-window-excursion
614 "to make a binding to record entire window configuration")
615 (byte-defop 140 0 byte-save-restriction
616 "to make a binding to record the current buffer clipping restrictions")
617 (byte-defop 141 -1 byte-catch
618 "for catch. Takes, on stack, the tag and an expression for the body")
619 (byte-defop 142 -1 byte-unwind-protect
620 "for unwind-protect. Takes, on stack, an expression for the unwind-action")
621
622 ;; For condition-case. Takes, on stack, the variable to bind,
623 ;; an expression for the body, and a list of clauses.
624 (byte-defop 143 -2 byte-condition-case)
625
626 ;; For entry to with-output-to-temp-buffer.
627 ;; Takes, on stack, the buffer name.
628 ;; Binds standard-output and does some other things.
629 ;; Returns with temp buffer on the stack in place of buffer name.
630 (byte-defop 144 0 byte-temp-output-buffer-setup)
631
632 ;; For exit from with-output-to-temp-buffer.
633 ;; Expects the temp buffer on the stack underneath value to return.
634 ;; Pops them both, then pushes the value back on.
635 ;; Unbinds standard-output and makes the temp buffer visible.
636 (byte-defop 145 -1 byte-temp-output-buffer-show)
637
638 ;; these ops are new to v19
639
640 ;; To unbind back to the beginning of this frame.
641 ;; Not used yet, but will be needed for tail-recursion elimination.
642 (byte-defop 146 0 byte-unbind-all)
643
644 ;; these ops are new to v19
645 (byte-defop 147 -2 byte-set-marker)
646 (byte-defop 148 0 byte-match-beginning)
647 (byte-defop 149 0 byte-match-end)
648 (byte-defop 150 0 byte-upcase)
649 (byte-defop 151 0 byte-downcase)
650 (byte-defop 152 -1 byte-string=)
651 (byte-defop 153 -1 byte-string<)
652 (byte-defop 154 -1 byte-equal)
653 (byte-defop 155 -1 byte-nthcdr)
654 (byte-defop 156 -1 byte-elt)
655 (byte-defop 157 -1 byte-member)
656 (byte-defop 158 -1 byte-assq)
657 (byte-defop 159 0 byte-nreverse)
658 (byte-defop 160 -1 byte-setcar)
659 (byte-defop 161 -1 byte-setcdr)
660 (byte-defop 162 0 byte-car-safe)
661 (byte-defop 163 0 byte-cdr-safe)
662 (byte-defop 164 -1 byte-nconc)
663 (byte-defop 165 -1 byte-quo)
664 (byte-defop 166 -1 byte-rem)
665 (byte-defop 167 0 byte-numberp)
666 (byte-defop 168 0 byte-integerp)
667
668 ;; unused: 169-174
669 (byte-defop 175 nil byte-listN)
670 (byte-defop 176 nil byte-concatN)
671 (byte-defop 177 nil byte-insertN)
672
673 ;; unused: 178-191
674
675 (byte-defop 192 1 byte-constant "for reference to a constant")
676 ;; codes 193-255 are consumed by byte-constant.
677 (defconst byte-constant-limit 64
678 "Exclusive maximum index usable in the `byte-constant' opcode.")
679
680 (defconst byte-goto-ops '(byte-goto byte-goto-if-nil byte-goto-if-not-nil
681 byte-goto-if-nil-else-pop
682 byte-goto-if-not-nil-else-pop)
683 "List of byte-codes whose offset is a pc.")
684
685 (defconst byte-goto-always-pop-ops '(byte-goto-if-nil byte-goto-if-not-nil))
686
687 (byte-extrude-byte-code-vectors)
688 \f
689 ;;; lapcode generator
690 ;;
691 ;; the byte-compiler now does source -> lapcode -> bytecode instead of
692 ;; source -> bytecode, because it's a lot easier to make optimizations
693 ;; on lapcode than on bytecode.
694 ;;
695 ;; Elements of the lapcode list are of the form (<instruction> . <parameter>)
696 ;; where instruction is a symbol naming a byte-code instruction,
697 ;; and parameter is an argument to that instruction, if any.
698 ;;
699 ;; The instruction can be the pseudo-op TAG, which means that this position
700 ;; in the instruction stream is a target of a goto. (car PARAMETER) will be
701 ;; the PC for this location, and the whole instruction "(TAG pc)" will be the
702 ;; parameter for some goto op.
703 ;;
704 ;; If the operation is varbind, varref, varset or push-constant, then the
705 ;; parameter is (variable/constant . index_in_constant_vector).
706 ;;
707 ;; First, the source code is macroexpanded and optimized in various ways.
708 ;; Then the resultant code is compiled into lapcode. Another set of
709 ;; optimizations are then run over the lapcode. Then the variables and
710 ;; constants referenced by the lapcode are collected and placed in the
711 ;; constants-vector. (This happens now so that variables referenced by dead
712 ;; code don't consume space.) And finally, the lapcode is transformed into
713 ;; compacted byte-code.
714 ;;
715 ;; A distinction is made between variables and constants because the variable-
716 ;; referencing instructions are more sensitive to the variables being near the
717 ;; front of the constants-vector than the constant-referencing instructions.
718 ;; Also, this lets us notice references to free variables.
719
720 (defun byte-compile-lapcode (lap)
721 "Turns lapcode into bytecode. The lapcode is destroyed."
722 ;; Lapcode modifications: changes the ID of a tag to be the tag's PC.
723 (let ((pc 0) ; Program counter
724 op off ; Operation & offset
725 (bytes '()) ; Put the output bytes here
726 (patchlist nil)) ; List of tags and goto's to patch
727 (while lap
728 (setq op (car (car lap))
729 off (cdr (car lap)))
730 (cond ((not (symbolp op))
731 (error "Non-symbolic opcode `%s'" op))
732 ((eq op 'TAG)
733 (setcar off pc)
734 (setq patchlist (cons off patchlist)))
735 ((memq op byte-goto-ops)
736 (setq pc (+ pc 3))
737 (setq bytes (cons (cons pc (cdr off))
738 (cons nil
739 (cons (symbol-value op) bytes))))
740 (setq patchlist (cons bytes patchlist)))
741 (t
742 (setq bytes
743 (cond ((cond ((consp off)
744 ;; Variable or constant reference
745 (setq off (cdr off))
746 (eq op 'byte-constant)))
747 (cond ((< off byte-constant-limit)
748 (setq pc (1+ pc))
749 (cons (+ byte-constant off) bytes))
750 (t
751 (setq pc (+ 3 pc))
752 (cons (lsh off -8)
753 (cons (logand off 255)
754 (cons byte-constant2 bytes))))))
755 ((<= byte-listN (symbol-value op))
756 (setq pc (+ 2 pc))
757 (cons off (cons (symbol-value op) bytes)))
758 ((< off 6)
759 (setq pc (1+ pc))
760 (cons (+ (symbol-value op) off) bytes))
761 ((< off 256)
762 (setq pc (+ 2 pc))
763 (cons off (cons (+ (symbol-value op) 6) bytes)))
764 (t
765 (setq pc (+ 3 pc))
766 (cons (lsh off -8)
767 (cons (logand off 255)
768 (cons (+ (symbol-value op) 7)
769 bytes))))))))
770 (setq lap (cdr lap)))
771 ;;(if (not (= pc (length bytes)))
772 ;; (error "Compiler error: pc mismatch - %s %s" pc (length bytes)))
773 ;; Patch PC into jumps
774 (let (bytes)
775 (while patchlist
776 (setq bytes (car patchlist))
777 (cond ((atom (car bytes))) ; Tag
778 (t ; Absolute jump
779 (setq pc (car (cdr (car bytes)))) ; Pick PC from tag
780 (setcar (cdr bytes) (logand pc 255))
781 (setcar bytes (lsh pc -8))
782 ;; FIXME: Replace this by some workaround.
783 (if (> (car bytes) 255) (error "Bytecode overflow"))))
784 (setq patchlist (cdr patchlist))))
785 (apply 'unibyte-string (nreverse bytes))))
786
787 \f
788 ;;; compile-time evaluation
789
790 (defun byte-compile-cl-file-p (file)
791 "Return non-nil if FILE is one of the CL files."
792 (and (stringp file)
793 (string-match "^cl\\>" (file-name-nondirectory file))))
794
795 (defun byte-compile-eval (form)
796 "Eval FORM and mark the functions defined therein.
797 Each function's symbol gets added to `byte-compile-noruntime-functions'."
798 (let ((hist-orig load-history)
799 (hist-nil-orig current-load-list))
800 (prog1 (eval form)
801 (when (byte-compile-warning-enabled-p 'noruntime)
802 (let ((hist-new load-history)
803 (hist-nil-new current-load-list))
804 ;; Go through load-history, look for newly loaded files
805 ;; and mark all the functions defined therein.
806 (while (and hist-new (not (eq hist-new hist-orig)))
807 (let ((xs (pop hist-new))
808 old-autoloads)
809 ;; Make sure the file was not already loaded before.
810 (unless (or (assoc (car xs) hist-orig)
811 ;; Don't give both the "noruntime" and
812 ;; "cl-functions" warning for the same function.
813 ;; FIXME This seems incorrect - these are two
814 ;; independent warnings. For example, you may be
815 ;; choosing to see the cl warnings but ignore them.
816 ;; You probably don't want to ignore noruntime in the
817 ;; same way.
818 (and (byte-compile-warning-enabled-p 'cl-functions)
819 (byte-compile-cl-file-p (car xs))))
820 (dolist (s xs)
821 (cond
822 ((symbolp s)
823 (unless (memq s old-autoloads)
824 (push s byte-compile-noruntime-functions)))
825 ((and (consp s) (eq t (car s)))
826 (push (cdr s) old-autoloads))
827 ((and (consp s) (eq 'autoload (car s)))
828 (push (cdr s) byte-compile-noruntime-functions)))))))
829 ;; Go through current-load-list for the locally defined funs.
830 (let (old-autoloads)
831 (while (and hist-nil-new (not (eq hist-nil-new hist-nil-orig)))
832 (let ((s (pop hist-nil-new)))
833 (when (and (symbolp s) (not (memq s old-autoloads)))
834 (push s byte-compile-noruntime-functions))
835 (when (and (consp s) (eq t (car s)))
836 (push (cdr s) old-autoloads)))))))
837 (when (byte-compile-warning-enabled-p 'cl-functions)
838 (let ((hist-new load-history))
839 ;; Go through load-history, looking for the cl files.
840 ;; Since new files are added at the start of load-history,
841 ;; we scan the new history until the tail matches the old.
842 (while (and (not byte-compile-cl-functions)
843 hist-new (not (eq hist-new hist-orig)))
844 ;; We used to check if the file had already been loaded,
845 ;; but it is better to check non-nil byte-compile-cl-functions.
846 (and (byte-compile-cl-file-p (car (pop hist-new)))
847 (byte-compile-find-cl-functions))))))))
848
849 (defun byte-compile-eval-before-compile (form)
850 "Evaluate FORM for `eval-and-compile'."
851 (let ((hist-nil-orig current-load-list))
852 (prog1 (eval form)
853 ;; (eval-and-compile (require 'cl) turns off warnings for cl functions.
854 ;; FIXME Why does it do that - just as a hack?
855 ;; There are other ways to do this nowadays.
856 (let ((tem current-load-list))
857 (while (not (eq tem hist-nil-orig))
858 (when (equal (car tem) '(require . cl))
859 (byte-compile-disable-warning 'cl-functions))
860 (setq tem (cdr tem)))))))
861 \f
862 ;;; byte compiler messages
863
864 (defvar byte-compile-current-form nil)
865 (defvar byte-compile-dest-file nil)
866 (defvar byte-compile-current-file nil)
867 (defvar byte-compile-current-group nil)
868 (defvar byte-compile-current-buffer nil)
869
870 ;; Log something that isn't a warning.
871 (defmacro byte-compile-log (format-string &rest args)
872 `(and
873 byte-optimize
874 (memq byte-optimize-log '(t source))
875 (let ((print-escape-newlines t)
876 (print-level 4)
877 (print-length 4))
878 (byte-compile-log-1
879 (format
880 ,format-string
881 ,@(mapcar
882 (lambda (x) (if (symbolp x) (list 'prin1-to-string x) x))
883 args))))))
884
885 ;; Log something that isn't a warning.
886 (defun byte-compile-log-1 (string)
887 (with-current-buffer "*Compile-Log*"
888 (let ((inhibit-read-only t))
889 (goto-char (point-max))
890 (byte-compile-warning-prefix nil nil)
891 (cond (noninteractive
892 (message " %s" string))
893 (t
894 (insert (format "%s\n" string)))))))
895
896 (defvar byte-compile-read-position nil
897 "Character position we began the last `read' from.")
898 (defvar byte-compile-last-position nil
899 "Last known character position in the input.")
900
901 ;; copied from gnus-util.el
902 (defsubst byte-compile-delete-first (elt list)
903 (if (eq (car list) elt)
904 (cdr list)
905 (let ((total list))
906 (while (and (cdr list)
907 (not (eq (cadr list) elt)))
908 (setq list (cdr list)))
909 (when (cdr list)
910 (setcdr list (cddr list)))
911 total)))
912
913 ;; The purpose of this function is to iterate through the
914 ;; `read-symbol-positions-list'. Each time we process, say, a
915 ;; function definition (`defun') we remove `defun' from
916 ;; `read-symbol-positions-list', and set `byte-compile-last-position'
917 ;; to that symbol's character position. Similarly, if we encounter a
918 ;; variable reference, like in (1+ foo), we remove `foo' from the
919 ;; list. If our current position is after the symbol's position, we
920 ;; assume we've already passed that point, and look for the next
921 ;; occurrence of the symbol.
922 ;;
923 ;; This function should not be called twice for the same occurrence of
924 ;; a symbol, and it should not be called for symbols generated by the
925 ;; byte compiler itself; because rather than just fail looking up the
926 ;; symbol, we may find an occurrence of the symbol further ahead, and
927 ;; then `byte-compile-last-position' as advanced too far.
928 ;;
929 ;; So your're probably asking yourself: Isn't this function a
930 ;; gross hack? And the answer, of course, would be yes.
931 (defun byte-compile-set-symbol-position (sym &optional allow-previous)
932 (when byte-compile-read-position
933 (let (last entry)
934 (while (progn
935 (setq last byte-compile-last-position
936 entry (assq sym read-symbol-positions-list))
937 (when entry
938 (setq byte-compile-last-position
939 (+ byte-compile-read-position (cdr entry))
940 read-symbol-positions-list
941 (byte-compile-delete-first
942 entry read-symbol-positions-list)))
943 (or (and allow-previous (not (= last byte-compile-last-position)))
944 (> last byte-compile-last-position)))))))
945
946 (defvar byte-compile-last-warned-form nil)
947 (defvar byte-compile-last-logged-file nil)
948
949 ;; This is used as warning-prefix for the compiler.
950 ;; It is always called with the warnings buffer current.
951 (defun byte-compile-warning-prefix (level entry)
952 (let* ((inhibit-read-only t)
953 (dir default-directory)
954 (file (cond ((stringp byte-compile-current-file)
955 (format "%s:" (file-relative-name byte-compile-current-file dir)))
956 ((bufferp byte-compile-current-file)
957 (format "Buffer %s:"
958 (buffer-name byte-compile-current-file)))
959 (t "")))
960 (pos (if (and byte-compile-current-file
961 (integerp byte-compile-read-position))
962 (with-current-buffer byte-compile-current-buffer
963 (format "%d:%d:"
964 (save-excursion
965 (goto-char byte-compile-last-position)
966 (1+ (count-lines (point-min) (point-at-bol))))
967 (save-excursion
968 (goto-char byte-compile-last-position)
969 (1+ (current-column)))))
970 ""))
971 (form (if (eq byte-compile-current-form :end) "end of data"
972 (or byte-compile-current-form "toplevel form"))))
973 (when (or (and byte-compile-current-file
974 (not (equal byte-compile-current-file
975 byte-compile-last-logged-file)))
976 (and byte-compile-current-form
977 (not (eq byte-compile-current-form
978 byte-compile-last-warned-form))))
979 (insert (format "\nIn %s:\n" form)))
980 (when level
981 (insert (format "%s%s" file pos))))
982 (setq byte-compile-last-logged-file byte-compile-current-file
983 byte-compile-last-warned-form byte-compile-current-form)
984 entry)
985
986 ;; This no-op function is used as the value of warning-series
987 ;; to tell inner calls to displaying-byte-compile-warnings
988 ;; not to bind warning-series.
989 (defun byte-compile-warning-series (&rest ignore)
990 nil)
991
992 ;; (compile-mode) will cause this to be loaded.
993 (declare-function compilation-forget-errors "compile" ())
994
995 ;; Log the start of a file in *Compile-Log*, and mark it as done.
996 ;; Return the position of the start of the page in the log buffer.
997 ;; But do nothing in batch mode.
998 (defun byte-compile-log-file ()
999 (and (not (equal byte-compile-current-file byte-compile-last-logged-file))
1000 (not noninteractive)
1001 (with-current-buffer (get-buffer-create "*Compile-Log*")
1002 (goto-char (point-max))
1003 (let* ((inhibit-read-only t)
1004 (dir (and byte-compile-current-file
1005 (file-name-directory byte-compile-current-file)))
1006 (was-same (equal default-directory dir))
1007 pt)
1008 (when dir
1009 (unless was-same
1010 (insert (format "Leaving directory `%s'\n" default-directory))))
1011 (unless (bolp)
1012 (insert "\n"))
1013 (setq pt (point-marker))
1014 (if byte-compile-current-file
1015 (insert "\f\nCompiling "
1016 (if (stringp byte-compile-current-file)
1017 (concat "file " byte-compile-current-file)
1018 (concat "buffer " (buffer-name byte-compile-current-file)))
1019 " at " (current-time-string) "\n")
1020 (insert "\f\nCompiling no file at " (current-time-string) "\n"))
1021 (when dir
1022 (setq default-directory dir)
1023 (unless was-same
1024 (insert (format "Entering directory `%s'\n" default-directory))))
1025 (setq byte-compile-last-logged-file byte-compile-current-file
1026 byte-compile-last-warned-form nil)
1027 ;; Do this after setting default-directory.
1028 (unless (derived-mode-p 'compilation-mode) (compilation-mode))
1029 (compilation-forget-errors)
1030 pt))))
1031
1032 ;; Log a message STRING in *Compile-Log*.
1033 ;; Also log the current function and file if not already done.
1034 (defun byte-compile-log-warning (string &optional fill level)
1035 (let ((warning-prefix-function 'byte-compile-warning-prefix)
1036 (warning-type-format "")
1037 (warning-fill-prefix (if fill " "))
1038 (inhibit-read-only t))
1039 (display-warning 'bytecomp string level "*Compile-Log*")))
1040
1041 (defun byte-compile-warn (format &rest args)
1042 "Issue a byte compiler warning; use (format FORMAT ARGS...) for message."
1043 (setq format (apply 'format format args))
1044 (if byte-compile-error-on-warn
1045 (error "%s" format) ; byte-compile-file catches and logs it
1046 (byte-compile-log-warning format t :warning)))
1047
1048 (defun byte-compile-warn-obsolete (symbol)
1049 "Warn that SYMBOL (a variable or function) is obsolete."
1050 (when (byte-compile-warning-enabled-p 'obsolete)
1051 (let* ((funcp (get symbol 'byte-obsolete-info))
1052 (obsolete (or funcp (get symbol 'byte-obsolete-variable)))
1053 (instead (car obsolete))
1054 (asof (if funcp (nth 2 obsolete) (cdr obsolete))))
1055 (unless (and funcp (memq symbol byte-compile-not-obsolete-funcs))
1056 (byte-compile-warn "`%s' is an obsolete %s%s%s" symbol
1057 (if funcp "function" "variable")
1058 (if asof (concat " (as of Emacs " asof ")") "")
1059 (cond ((stringp instead)
1060 (concat "; " instead))
1061 (instead
1062 (format "; use `%s' instead." instead))
1063 (t ".")))))))
1064
1065 (defun byte-compile-report-error (error-info)
1066 "Report Lisp error in compilation. ERROR-INFO is the error data."
1067 (setq byte-compiler-error-flag t)
1068 (byte-compile-log-warning
1069 (error-message-string error-info)
1070 nil :error))
1071
1072 ;;; Used by make-obsolete.
1073 (defun byte-compile-obsolete (form)
1074 (byte-compile-set-symbol-position (car form))
1075 (byte-compile-warn-obsolete (car form))
1076 (funcall (or (cadr (get (car form) 'byte-obsolete-info)) ; handler
1077 'byte-compile-normal-call) form))
1078 \f
1079 ;;; sanity-checking arglists
1080
1081 (defun byte-compile-fdefinition (name macro-p)
1082 ;; If a function has an entry saying (FUNCTION . t).
1083 ;; that means we know it is defined but we don't know how.
1084 ;; If a function has an entry saying (FUNCTION . nil),
1085 ;; that means treat it as not defined.
1086 (let* ((list (if macro-p
1087 byte-compile-macro-environment
1088 byte-compile-function-environment))
1089 (env (cdr (assq name list))))
1090 (or env
1091 (let ((fn name))
1092 (while (and (symbolp fn)
1093 (fboundp fn)
1094 (or (symbolp (symbol-function fn))
1095 (consp (symbol-function fn))
1096 (and (not macro-p)
1097 (byte-code-function-p (symbol-function fn)))))
1098 (setq fn (symbol-function fn)))
1099 (let ((advertised (gethash (if (and (symbolp fn) (fboundp fn))
1100 ;; Could be a subr.
1101 (symbol-function fn)
1102 fn)
1103 advertised-signature-table t)))
1104 (cond
1105 ((listp advertised)
1106 (if macro-p
1107 `(macro lambda ,advertised)
1108 `(lambda ,advertised)))
1109 ((and (not macro-p) (byte-code-function-p fn)) fn)
1110 ((not (consp fn)) nil)
1111 ((eq 'macro (car fn)) (cdr fn))
1112 (macro-p nil)
1113 ((eq 'autoload (car fn)) nil)
1114 (t fn)))))))
1115
1116 (defun byte-compile-arglist-signature (arglist)
1117 (let ((args 0)
1118 opts
1119 restp)
1120 (while arglist
1121 (cond ((eq (car arglist) '&optional)
1122 (or opts (setq opts 0)))
1123 ((eq (car arglist) '&rest)
1124 (if (cdr arglist)
1125 (setq restp t
1126 arglist nil)))
1127 (t
1128 (if opts
1129 (setq opts (1+ opts))
1130 (setq args (1+ args)))))
1131 (setq arglist (cdr arglist)))
1132 (cons args (if restp nil (if opts (+ args opts) args)))))
1133
1134
1135 (defun byte-compile-arglist-signatures-congruent-p (old new)
1136 (not (or
1137 (> (car new) (car old)) ; requires more args now
1138 (and (null (cdr old)) ; took rest-args, doesn't any more
1139 (cdr new))
1140 (and (cdr new) (cdr old) ; can't take as many args now
1141 (< (cdr new) (cdr old)))
1142 )))
1143
1144 (defun byte-compile-arglist-signature-string (signature)
1145 (cond ((null (cdr signature))
1146 (format "%d+" (car signature)))
1147 ((= (car signature) (cdr signature))
1148 (format "%d" (car signature)))
1149 (t (format "%d-%d" (car signature) (cdr signature)))))
1150
1151
1152 ;; Warn if the form is calling a function with the wrong number of arguments.
1153 (defun byte-compile-callargs-warn (form)
1154 (let* ((def (or (byte-compile-fdefinition (car form) nil)
1155 (byte-compile-fdefinition (car form) t)))
1156 (sig (if (and def (not (eq def t)))
1157 (progn
1158 (and (eq (car-safe def) 'macro)
1159 (eq (car-safe (cdr-safe def)) 'lambda)
1160 (setq def (cdr def)))
1161 (byte-compile-arglist-signature
1162 (if (memq (car-safe def) '(declared lambda))
1163 (nth 1 def)
1164 (if (byte-code-function-p def)
1165 (aref def 0)
1166 '(&rest def)))))
1167 (if (and (fboundp (car form))
1168 (subrp (symbol-function (car form))))
1169 (subr-arity (symbol-function (car form))))))
1170 (ncall (length (cdr form))))
1171 ;; Check many or unevalled from subr-arity.
1172 (if (and (cdr-safe sig)
1173 (not (numberp (cdr sig))))
1174 (setcdr sig nil))
1175 (if sig
1176 (when (or (< ncall (car sig))
1177 (and (cdr sig) (> ncall (cdr sig))))
1178 (byte-compile-set-symbol-position (car form))
1179 (byte-compile-warn
1180 "%s called with %d argument%s, but %s %s"
1181 (car form) ncall
1182 (if (= 1 ncall) "" "s")
1183 (if (< ncall (car sig))
1184 "requires"
1185 "accepts only")
1186 (byte-compile-arglist-signature-string sig))))
1187 (byte-compile-format-warn form)
1188 ;; Check to see if the function will be available at runtime
1189 ;; and/or remember its arity if it's unknown.
1190 (or (and (or def (fboundp (car form))) ; might be a subr or autoload.
1191 (not (memq (car form) byte-compile-noruntime-functions)))
1192 (eq (car form) byte-compile-current-form) ; ## this doesn't work
1193 ; with recursion.
1194 ;; It's a currently-undefined function.
1195 ;; Remember number of args in call.
1196 (let ((cons (assq (car form) byte-compile-unresolved-functions))
1197 (n (length (cdr form))))
1198 (if cons
1199 (or (memq n (cdr cons))
1200 (setcdr cons (cons n (cdr cons))))
1201 (push (list (car form) n)
1202 byte-compile-unresolved-functions))))))
1203
1204 (defun byte-compile-format-warn (form)
1205 "Warn if FORM is `format'-like with inconsistent args.
1206 Applies if head of FORM is a symbol with non-nil property
1207 `byte-compile-format-like' and first arg is a constant string.
1208 Then check the number of format fields matches the number of
1209 extra args."
1210 (when (and (symbolp (car form))
1211 (stringp (nth 1 form))
1212 (get (car form) 'byte-compile-format-like))
1213 (let ((nfields (with-temp-buffer
1214 (insert (nth 1 form))
1215 (goto-char (point-min))
1216 (let ((n 0))
1217 (while (re-search-forward "%." nil t)
1218 (unless (eq ?% (char-after (1+ (match-beginning 0))))
1219 (setq n (1+ n))))
1220 n)))
1221 (nargs (- (length form) 2)))
1222 (unless (= nargs nfields)
1223 (byte-compile-warn
1224 "`%s' called with %d args to fill %d format field(s)" (car form)
1225 nargs nfields)))))
1226
1227 (dolist (elt '(format message error))
1228 (put elt 'byte-compile-format-like t))
1229
1230 ;; Warn if a custom definition fails to specify :group.
1231 (defun byte-compile-nogroup-warn (form)
1232 (if (and (memq (car form) '(custom-declare-face custom-declare-variable))
1233 byte-compile-current-group)
1234 ;; The group will be provided implicitly.
1235 nil
1236 (let ((keyword-args (cdr (cdr (cdr (cdr form)))))
1237 (name (cadr form)))
1238 (or (not (eq (car-safe name) 'quote))
1239 (and (eq (car form) 'custom-declare-group)
1240 (equal name ''emacs))
1241 (plist-get keyword-args :group)
1242 (not (and (consp name) (eq (car name) 'quote)))
1243 (byte-compile-warn
1244 "%s for `%s' fails to specify containing group"
1245 (cdr (assq (car form)
1246 '((custom-declare-group . defgroup)
1247 (custom-declare-face . defface)
1248 (custom-declare-variable . defcustom))))
1249 (cadr name)))
1250 ;; Update the current group, if needed.
1251 (if (and byte-compile-current-file ;Only when byte-compiling a whole file.
1252 (eq (car form) 'custom-declare-group)
1253 (eq (car-safe name) 'quote))
1254 (setq byte-compile-current-group (cadr name))))))
1255
1256 ;; Warn if the function or macro is being redefined with a different
1257 ;; number of arguments.
1258 (defun byte-compile-arglist-warn (form macrop)
1259 (let ((old (byte-compile-fdefinition (nth 1 form) macrop)))
1260 (if (and old (not (eq old t)))
1261 (progn
1262 (and (eq 'macro (car-safe old))
1263 (eq 'lambda (car-safe (cdr-safe old)))
1264 (setq old (cdr old)))
1265 (let ((sig1 (byte-compile-arglist-signature
1266 (if (eq 'lambda (car-safe old))
1267 (nth 1 old)
1268 (if (byte-code-function-p old)
1269 (aref old 0)
1270 '(&rest def)))))
1271 (sig2 (byte-compile-arglist-signature (nth 2 form))))
1272 (unless (byte-compile-arglist-signatures-congruent-p sig1 sig2)
1273 (byte-compile-set-symbol-position (nth 1 form))
1274 (byte-compile-warn
1275 "%s %s used to take %s %s, now takes %s"
1276 (if (eq (car form) 'defun) "function" "macro")
1277 (nth 1 form)
1278 (byte-compile-arglist-signature-string sig1)
1279 (if (equal sig1 '(1 . 1)) "argument" "arguments")
1280 (byte-compile-arglist-signature-string sig2)))))
1281 ;; This is the first definition. See if previous calls are compatible.
1282 (let ((calls (assq (nth 1 form) byte-compile-unresolved-functions))
1283 nums sig min max)
1284 (if calls
1285 (progn
1286 (setq sig (byte-compile-arglist-signature (nth 2 form))
1287 nums (sort (copy-sequence (cdr calls)) (function <))
1288 min (car nums)
1289 max (car (nreverse nums)))
1290 (when (or (< min (car sig))
1291 (and (cdr sig) (> max (cdr sig))))
1292 (byte-compile-set-symbol-position (nth 1 form))
1293 (byte-compile-warn
1294 "%s being defined to take %s%s, but was previously called with %s"
1295 (nth 1 form)
1296 (byte-compile-arglist-signature-string sig)
1297 (if (equal sig '(1 . 1)) " arg" " args")
1298 (byte-compile-arglist-signature-string (cons min max))))
1299
1300 (setq byte-compile-unresolved-functions
1301 (delq calls byte-compile-unresolved-functions)))))
1302 )))
1303
1304 (defvar byte-compile-cl-functions nil
1305 "List of functions defined in CL.")
1306
1307 ;; Can't just add this to cl-load-hook, because that runs just before
1308 ;; the forms from cl.el get added to load-history.
1309 (defun byte-compile-find-cl-functions ()
1310 (unless byte-compile-cl-functions
1311 (dolist (elt load-history)
1312 (and (byte-compile-cl-file-p (car elt))
1313 (dolist (e (cdr elt))
1314 ;; Includes the cl-foo functions that cl autoloads.
1315 (when (memq (car-safe e) '(autoload defun))
1316 (push (cdr e) byte-compile-cl-functions)))))))
1317
1318 (defun byte-compile-cl-warn (form)
1319 "Warn if FORM is a call of a function from the CL package."
1320 (let ((func (car-safe form)))
1321 (if (and byte-compile-cl-functions
1322 (memq func byte-compile-cl-functions)
1323 ;; Aliases which won't have been expanded at this point.
1324 ;; These aren't all aliases of subrs, so not trivial to
1325 ;; avoid hardwiring the list.
1326 (not (memq func
1327 '(cl-block-wrapper cl-block-throw
1328 multiple-value-call nth-value
1329 copy-seq first second rest endp cl-member
1330 ;; These are included in generated code
1331 ;; that can't be called except at compile time
1332 ;; or unless cl is loaded anyway.
1333 cl-defsubst-expand cl-struct-setf-expander
1334 ;; These would sometimes be warned about
1335 ;; but such warnings are never useful,
1336 ;; so don't warn about them.
1337 macroexpand cl-macroexpand-all
1338 cl-compiling-file)))
1339 ;; Avoid warnings for things which are safe because they
1340 ;; have suitable compiler macros, but those aren't
1341 ;; expanded at this stage. There should probably be more
1342 ;; here than caaar and friends.
1343 (not (and (eq (get func 'byte-compile)
1344 'cl-byte-compile-compiler-macro)
1345 (string-match "\\`c[ad]+r\\'" (symbol-name func)))))
1346 (byte-compile-warn "function `%s' from cl package called at runtime"
1347 func)))
1348 form)
1349
1350 (defun byte-compile-print-syms (str1 strn syms)
1351 (when syms
1352 (byte-compile-set-symbol-position (car syms) t))
1353 (cond ((and (cdr syms) (not noninteractive))
1354 (let* ((str strn)
1355 (L (length str))
1356 s)
1357 (while syms
1358 (setq s (symbol-name (pop syms))
1359 L (+ L (length s) 2))
1360 (if (< L (1- fill-column))
1361 (setq str (concat str " " s (and syms ",")))
1362 (setq str (concat str "\n " s (and syms ","))
1363 L (+ (length s) 4))))
1364 (byte-compile-warn "%s" str)))
1365 ((cdr syms)
1366 (byte-compile-warn "%s %s"
1367 strn
1368 (mapconcat #'symbol-name syms ", ")))
1369
1370 (syms
1371 (byte-compile-warn str1 (car syms)))))
1372
1373 ;; If we have compiled any calls to functions which are not known to be
1374 ;; defined, issue a warning enumerating them.
1375 ;; `unresolved' in the list `byte-compile-warnings' disables this.
1376 (defun byte-compile-warn-about-unresolved-functions ()
1377 (when (byte-compile-warning-enabled-p 'unresolved)
1378 (let ((byte-compile-current-form :end)
1379 (noruntime nil)
1380 (unresolved nil))
1381 ;; Separate the functions that will not be available at runtime
1382 ;; from the truly unresolved ones.
1383 (dolist (f byte-compile-unresolved-functions)
1384 (setq f (car f))
1385 (if (fboundp f) (push f noruntime) (push f unresolved)))
1386 ;; Complain about the no-run-time functions
1387 (byte-compile-print-syms
1388 "the function `%s' might not be defined at runtime."
1389 "the following functions might not be defined at runtime:"
1390 noruntime)
1391 ;; Complain about the unresolved functions
1392 (byte-compile-print-syms
1393 "the function `%s' is not known to be defined."
1394 "the following functions are not known to be defined:"
1395 unresolved)))
1396 nil)
1397
1398 \f
1399 (defsubst byte-compile-const-symbol-p (symbol &optional any-value)
1400 "Non-nil if SYMBOL is constant.
1401 If ANY-VALUE is nil, only return non-nil if the value of the symbol is the
1402 symbol itself."
1403 (or (memq symbol '(nil t))
1404 (keywordp symbol)
1405 (if any-value
1406 (or (memq symbol byte-compile-const-variables)
1407 ;; FIXME: We should provide a less intrusive way to find out
1408 ;; is a variable is "constant".
1409 (and (boundp symbol)
1410 (condition-case nil
1411 (progn (set symbol (symbol-value symbol)) nil)
1412 (setting-constant t)))))))
1413
1414 (defmacro byte-compile-constp (form)
1415 "Return non-nil if FORM is a constant."
1416 `(cond ((consp ,form) (eq (car ,form) 'quote))
1417 ((not (symbolp ,form)))
1418 ((byte-compile-const-symbol-p ,form))))
1419
1420 (defmacro byte-compile-close-variables (&rest body)
1421 (cons 'let
1422 (cons '(;;
1423 ;; Close over these variables to encapsulate the
1424 ;; compilation state
1425 ;;
1426 (byte-compile-macro-environment
1427 ;; Copy it because the compiler may patch into the
1428 ;; macroenvironment.
1429 (copy-alist byte-compile-initial-macro-environment))
1430 (byte-compile-function-environment nil)
1431 (byte-compile-bound-variables nil)
1432 (byte-compile-const-variables nil)
1433 (byte-compile-free-references nil)
1434 (byte-compile-free-assignments nil)
1435 ;;
1436 ;; Close over these variables so that `byte-compiler-options'
1437 ;; can change them on a per-file basis.
1438 ;;
1439 (byte-compile-verbose byte-compile-verbose)
1440 (byte-optimize byte-optimize)
1441 (byte-compile-dynamic byte-compile-dynamic)
1442 (byte-compile-dynamic-docstrings
1443 byte-compile-dynamic-docstrings)
1444 ;; (byte-compile-generate-emacs19-bytecodes
1445 ;; byte-compile-generate-emacs19-bytecodes)
1446 (byte-compile-warnings byte-compile-warnings)
1447 )
1448 body)))
1449
1450 (defmacro displaying-byte-compile-warnings (&rest body)
1451 `(let* ((--displaying-byte-compile-warnings-fn (lambda () ,@body))
1452 (warning-series-started
1453 (and (markerp warning-series)
1454 (eq (marker-buffer warning-series)
1455 (get-buffer "*Compile-Log*")))))
1456 (byte-compile-find-cl-functions)
1457 (if (or (eq warning-series 'byte-compile-warning-series)
1458 warning-series-started)
1459 ;; warning-series does come from compilation,
1460 ;; so don't bind it, but maybe do set it.
1461 (let (tem)
1462 ;; Log the file name. Record position of that text.
1463 (setq tem (byte-compile-log-file))
1464 (unless warning-series-started
1465 (setq warning-series (or tem 'byte-compile-warning-series)))
1466 (if byte-compile-debug
1467 (funcall --displaying-byte-compile-warnings-fn)
1468 (condition-case error-info
1469 (funcall --displaying-byte-compile-warnings-fn)
1470 (error (byte-compile-report-error error-info)))))
1471 ;; warning-series does not come from compilation, so bind it.
1472 (let ((warning-series
1473 ;; Log the file name. Record position of that text.
1474 (or (byte-compile-log-file) 'byte-compile-warning-series)))
1475 (if byte-compile-debug
1476 (funcall --displaying-byte-compile-warnings-fn)
1477 (condition-case error-info
1478 (funcall --displaying-byte-compile-warnings-fn)
1479 (error (byte-compile-report-error error-info))))))))
1480 \f
1481 ;;;###autoload
1482 (defun byte-force-recompile (directory)
1483 "Recompile every `.el' file in DIRECTORY that already has a `.elc' file.
1484 Files in subdirectories of DIRECTORY are processed also."
1485 (interactive "DByte force recompile (directory): ")
1486 (byte-recompile-directory directory nil t))
1487
1488 ;; The `bytecomp-' prefix is applied to all local variables with
1489 ;; otherwise common names in this and similar functions for the sake
1490 ;; of the boundp test in byte-compile-variable-ref.
1491 ;; http://lists.gnu.org/archive/html/emacs-devel/2008-01/msg00237.html
1492 ;; http://lists.gnu.org/archive/html/bug-gnu-emacs/2008-02/msg00134.html
1493 ;; Note that similar considerations apply to command-line-1 in startup.el.
1494 ;;;###autoload
1495 (defun byte-recompile-directory (bytecomp-directory &optional bytecomp-arg
1496 bytecomp-force)
1497 "Recompile every `.el' file in BYTECOMP-DIRECTORY that needs recompilation.
1498 This happens when a `.elc' file exists but is older than the `.el' file.
1499 Files in subdirectories of BYTECOMP-DIRECTORY are processed also.
1500
1501 If the `.elc' file does not exist, normally this function *does not*
1502 compile the corresponding `.el' file. However, if the prefix argument
1503 BYTECOMP-ARG is 0, that means do compile all those files. A nonzero
1504 BYTECOMP-ARG means ask the user, for each such `.el' file, whether to
1505 compile it. A nonzero BYTECOMP-ARG also means ask about each subdirectory
1506 before scanning it.
1507
1508 If the third argument BYTECOMP-FORCE is non-nil, recompile every `.el' file
1509 that already has a `.elc' file."
1510 (interactive "DByte recompile directory: \nP")
1511 (if bytecomp-arg
1512 (setq bytecomp-arg (prefix-numeric-value bytecomp-arg)))
1513 (if noninteractive
1514 nil
1515 (save-some-buffers)
1516 (force-mode-line-update))
1517 (with-current-buffer (get-buffer-create "*Compile-Log*")
1518 (setq default-directory (expand-file-name bytecomp-directory))
1519 ;; compilation-mode copies value of default-directory.
1520 (unless (eq major-mode 'compilation-mode)
1521 (compilation-mode))
1522 (let ((bytecomp-directories (list default-directory))
1523 (default-directory default-directory)
1524 (skip-count 0)
1525 (fail-count 0)
1526 (file-count 0)
1527 (dir-count 0)
1528 last-dir)
1529 (displaying-byte-compile-warnings
1530 (while bytecomp-directories
1531 (setq bytecomp-directory (car bytecomp-directories))
1532 (message "Checking %s..." bytecomp-directory)
1533 (let ((bytecomp-files (directory-files bytecomp-directory))
1534 bytecomp-source bytecomp-dest)
1535 (dolist (bytecomp-file bytecomp-files)
1536 (setq bytecomp-source
1537 (expand-file-name bytecomp-file bytecomp-directory))
1538 (if (and (not (member bytecomp-file '("RCS" "CVS")))
1539 (not (eq ?\. (aref bytecomp-file 0)))
1540 (file-directory-p bytecomp-source)
1541 (not (file-symlink-p bytecomp-source)))
1542 ;; This file is a subdirectory. Handle them differently.
1543 (when (or (null bytecomp-arg)
1544 (eq 0 bytecomp-arg)
1545 (y-or-n-p (concat "Check " bytecomp-source "? ")))
1546 (setq bytecomp-directories
1547 (nconc bytecomp-directories (list bytecomp-source))))
1548 ;; It is an ordinary file. Decide whether to compile it.
1549 (if (and (string-match emacs-lisp-file-regexp bytecomp-source)
1550 (file-readable-p bytecomp-source)
1551 (not (auto-save-file-name-p bytecomp-source))
1552 (not (string-equal dir-locals-file
1553 (file-name-nondirectory
1554 bytecomp-source)))
1555 (setq bytecomp-dest
1556 (byte-compile-dest-file bytecomp-source))
1557 (if (file-exists-p bytecomp-dest)
1558 ;; File was already compiled.
1559 (or bytecomp-force
1560 (file-newer-than-file-p bytecomp-source
1561 bytecomp-dest))
1562 ;; No compiled file exists yet.
1563 (and bytecomp-arg
1564 (or (eq 0 bytecomp-arg)
1565 (y-or-n-p (concat "Compile "
1566 bytecomp-source "? "))))))
1567 (progn (if (and noninteractive (not byte-compile-verbose))
1568 (message "Compiling %s..." bytecomp-source))
1569 (let ((bytecomp-res (byte-compile-file
1570 bytecomp-source)))
1571 (cond ((eq bytecomp-res 'no-byte-compile)
1572 (setq skip-count (1+ skip-count)))
1573 ((eq bytecomp-res t)
1574 (setq file-count (1+ file-count)))
1575 ((eq bytecomp-res nil)
1576 (setq fail-count (1+ fail-count)))))
1577 (or noninteractive
1578 (message "Checking %s..." bytecomp-directory))
1579 (if (not (eq last-dir bytecomp-directory))
1580 (setq last-dir bytecomp-directory
1581 dir-count (1+ dir-count)))
1582 )))))
1583 (setq bytecomp-directories (cdr bytecomp-directories))))
1584 (message "Done (Total of %d file%s compiled%s%s%s)"
1585 file-count (if (= file-count 1) "" "s")
1586 (if (> fail-count 0) (format ", %d failed" fail-count) "")
1587 (if (> skip-count 0) (format ", %d skipped" skip-count) "")
1588 (if (> dir-count 1)
1589 (format " in %d directories" dir-count) "")))))
1590
1591 (defvar no-byte-compile nil
1592 "Non-nil to prevent byte-compiling of Emacs Lisp code.
1593 This is normally set in local file variables at the end of the elisp file:
1594
1595 ;; Local Variables:\n;; no-byte-compile: t\n;; End: ")
1596 ;;;###autoload(put 'no-byte-compile 'safe-local-variable 'booleanp)
1597
1598 ;;;###autoload
1599 (defun byte-compile-file (bytecomp-filename &optional load)
1600 "Compile a file of Lisp code named BYTECOMP-FILENAME into a file of byte code.
1601 The output file's name is generated by passing BYTECOMP-FILENAME to the
1602 function `byte-compile-dest-file' (which see).
1603 With prefix arg (noninteractively: 2nd arg), LOAD the file after compiling.
1604 The value is non-nil if there were no errors, nil if errors."
1605 ;; (interactive "fByte compile file: \nP")
1606 (interactive
1607 (let ((bytecomp-file buffer-file-name)
1608 (bytecomp-file-name nil)
1609 (bytecomp-file-dir nil))
1610 (and bytecomp-file
1611 (eq (cdr (assq 'major-mode (buffer-local-variables)))
1612 'emacs-lisp-mode)
1613 (setq bytecomp-file-name (file-name-nondirectory bytecomp-file)
1614 bytecomp-file-dir (file-name-directory bytecomp-file)))
1615 (list (read-file-name (if current-prefix-arg
1616 "Byte compile and load file: "
1617 "Byte compile file: ")
1618 bytecomp-file-dir bytecomp-file-name nil)
1619 current-prefix-arg)))
1620 ;; Expand now so we get the current buffer's defaults
1621 (setq bytecomp-filename (expand-file-name bytecomp-filename))
1622
1623 ;; If we're compiling a file that's in a buffer and is modified, offer
1624 ;; to save it first.
1625 (or noninteractive
1626 (let ((b (get-file-buffer (expand-file-name bytecomp-filename))))
1627 (if (and b (buffer-modified-p b)
1628 (y-or-n-p (format "Save buffer %s first? " (buffer-name b))))
1629 (with-current-buffer b (save-buffer)))))
1630
1631 ;; Force logging of the file name for each file compiled.
1632 (setq byte-compile-last-logged-file nil)
1633 (let ((byte-compile-current-file bytecomp-filename)
1634 (byte-compile-current-group nil)
1635 (set-auto-coding-for-load t)
1636 target-file input-buffer output-buffer
1637 byte-compile-dest-file)
1638 (setq target-file (byte-compile-dest-file bytecomp-filename))
1639 (setq byte-compile-dest-file target-file)
1640 (with-current-buffer
1641 (setq input-buffer (get-buffer-create " *Compiler Input*"))
1642 (erase-buffer)
1643 (setq buffer-file-coding-system nil)
1644 ;; Always compile an Emacs Lisp file as multibyte
1645 ;; unless the file itself forces unibyte with -*-coding: raw-text;-*-
1646 (set-buffer-multibyte t)
1647 (insert-file-contents bytecomp-filename)
1648 ;; Mimic the way after-insert-file-set-coding can make the
1649 ;; buffer unibyte when visiting this file.
1650 (when (or (eq last-coding-system-used 'no-conversion)
1651 (eq (coding-system-type last-coding-system-used) 5))
1652 ;; For coding systems no-conversion and raw-text...,
1653 ;; edit the buffer as unibyte.
1654 (set-buffer-multibyte nil))
1655 ;; Run hooks including the uncompression hook.
1656 ;; If they change the file name, then change it for the output also.
1657 (letf ((buffer-file-name bytecomp-filename)
1658 ((default-value 'major-mode) 'emacs-lisp-mode)
1659 ;; Ignore unsafe local variables.
1660 ;; We only care about a few of them for our purposes.
1661 (enable-local-variables :safe)
1662 (enable-local-eval nil))
1663 ;; Arg of t means don't alter enable-local-variables.
1664 (normal-mode t)
1665 (setq bytecomp-filename buffer-file-name))
1666 ;; Set the default directory, in case an eval-when-compile uses it.
1667 (setq default-directory (file-name-directory bytecomp-filename)))
1668 ;; Check if the file's local variables explicitly specify not to
1669 ;; compile this file.
1670 (if (with-current-buffer input-buffer no-byte-compile)
1671 (progn
1672 ;; (message "%s not compiled because of `no-byte-compile: %s'"
1673 ;; (file-relative-name bytecomp-filename)
1674 ;; (with-current-buffer input-buffer no-byte-compile))
1675 (when (file-exists-p target-file)
1676 (message "%s deleted because of `no-byte-compile: %s'"
1677 (file-relative-name target-file)
1678 (buffer-local-value 'no-byte-compile input-buffer))
1679 (condition-case nil (delete-file target-file) (error nil)))
1680 ;; We successfully didn't compile this file.
1681 'no-byte-compile)
1682 (when byte-compile-verbose
1683 (message "Compiling %s..." bytecomp-filename))
1684 (setq byte-compiler-error-flag nil)
1685 ;; It is important that input-buffer not be current at this call,
1686 ;; so that the value of point set in input-buffer
1687 ;; within byte-compile-from-buffer lingers in that buffer.
1688 (setq output-buffer
1689 (save-current-buffer
1690 (byte-compile-from-buffer input-buffer bytecomp-filename)))
1691 (if byte-compiler-error-flag
1692 nil
1693 (when byte-compile-verbose
1694 (message "Compiling %s...done" bytecomp-filename))
1695 (kill-buffer input-buffer)
1696 (with-current-buffer output-buffer
1697 (goto-char (point-max))
1698 (insert "\n") ; aaah, unix.
1699 (if (file-writable-p target-file)
1700 ;; We must disable any code conversion here.
1701 (let* ((coding-system-for-write 'no-conversion)
1702 ;; Write to a tempfile so that if another Emacs
1703 ;; process is trying to load target-file (eg in a
1704 ;; parallel bootstrap), it does not risk getting a
1705 ;; half-finished file. (Bug#4196)
1706 (tempfile (make-temp-name target-file))
1707 (kill-emacs-hook
1708 (cons (lambda () (ignore-errors (delete-file tempfile)))
1709 kill-emacs-hook)))
1710 (if (memq system-type '(ms-dos 'windows-nt))
1711 (setq buffer-file-type t))
1712 (write-region (point-min) (point-max) tempfile nil 1)
1713 ;; This has the intentional side effect that any
1714 ;; hard-links to target-file continue to
1715 ;; point to the old file (this makes it possible
1716 ;; for installed files to share disk space with
1717 ;; the build tree, without causing problems when
1718 ;; emacs-lisp files in the build tree are
1719 ;; recompiled). Previously this was accomplished by
1720 ;; deleting target-file before writing it.
1721 (rename-file tempfile target-file t)
1722 (message "Wrote %s" target-file))
1723 ;; This is just to give a better error message than write-region
1724 (signal 'file-error
1725 (list "Opening output file"
1726 (if (file-exists-p target-file)
1727 "cannot overwrite file"
1728 "directory not writable or nonexistent")
1729 target-file)))
1730 (kill-buffer (current-buffer)))
1731 (if (and byte-compile-generate-call-tree
1732 (or (eq t byte-compile-generate-call-tree)
1733 (y-or-n-p (format "Report call tree for %s? "
1734 bytecomp-filename))))
1735 (save-excursion
1736 (display-call-tree bytecomp-filename)))
1737 (if load
1738 (load target-file))
1739 t))))
1740
1741 ;;; compiling a single function
1742 ;;;###autoload
1743 (defun compile-defun (&optional arg)
1744 "Compile and evaluate the current top-level form.
1745 Print the result in the echo area.
1746 With argument ARG, insert value in current buffer after the form."
1747 (interactive "P")
1748 (save-excursion
1749 (end-of-defun)
1750 (beginning-of-defun)
1751 (let* ((byte-compile-current-file nil)
1752 (byte-compile-current-buffer (current-buffer))
1753 (byte-compile-read-position (point))
1754 (byte-compile-last-position byte-compile-read-position)
1755 (byte-compile-last-warned-form 'nothing)
1756 (value (eval
1757 (let ((read-with-symbol-positions (current-buffer))
1758 (read-symbol-positions-list nil))
1759 (displaying-byte-compile-warnings
1760 (byte-compile-sexp (read (current-buffer))))))))
1761 (cond (arg
1762 (message "Compiling from buffer... done.")
1763 (prin1 value (current-buffer))
1764 (insert "\n"))
1765 ((message "%s" (prin1-to-string value)))))))
1766
1767
1768 (defun byte-compile-from-buffer (bytecomp-inbuffer &optional bytecomp-filename)
1769 ;; Filename is used for the loading-into-Emacs-18 error message.
1770 (let (bytecomp-outbuffer
1771 (byte-compile-current-buffer bytecomp-inbuffer)
1772 (byte-compile-read-position nil)
1773 (byte-compile-last-position nil)
1774 ;; Prevent truncation of flonums and lists as we read and print them
1775 (float-output-format nil)
1776 (case-fold-search nil)
1777 (print-length nil)
1778 (print-level nil)
1779 ;; Prevent edebug from interfering when we compile
1780 ;; and put the output into a file.
1781 ;; (edebug-all-defs nil)
1782 ;; (edebug-all-forms nil)
1783 ;; Simulate entry to byte-compile-top-level
1784 (byte-compile-constants nil)
1785 (byte-compile-variables nil)
1786 (byte-compile-tag-number 0)
1787 (byte-compile-depth 0)
1788 (byte-compile-maxdepth 0)
1789 (byte-compile-output nil)
1790 ;; This allows us to get the positions of symbols read; it's
1791 ;; new in Emacs 22.1.
1792 (read-with-symbol-positions bytecomp-inbuffer)
1793 (read-symbol-positions-list nil)
1794 ;; #### This is bound in b-c-close-variables.
1795 ;; (byte-compile-warnings byte-compile-warnings)
1796 )
1797 (byte-compile-close-variables
1798 (with-current-buffer
1799 (setq bytecomp-outbuffer (get-buffer-create " *Compiler Output*"))
1800 (set-buffer-multibyte t)
1801 (erase-buffer)
1802 ;; (emacs-lisp-mode)
1803 (setq case-fold-search nil))
1804 (displaying-byte-compile-warnings
1805 (with-current-buffer bytecomp-inbuffer
1806 (and bytecomp-filename
1807 (byte-compile-insert-header bytecomp-filename bytecomp-outbuffer))
1808 (goto-char (point-min))
1809 ;; Should we always do this? When calling multiple files, it
1810 ;; would be useful to delay this warning until all have been
1811 ;; compiled. A: Yes! b-c-u-f might contain dross from a
1812 ;; previous byte-compile.
1813 (setq byte-compile-unresolved-functions nil)
1814
1815 ;; Compile the forms from the input buffer.
1816 (while (progn
1817 (while (progn (skip-chars-forward " \t\n\^l")
1818 (looking-at ";"))
1819 (forward-line 1))
1820 (not (eobp)))
1821 (setq byte-compile-read-position (point)
1822 byte-compile-last-position byte-compile-read-position)
1823 (let* ((old-style-backquotes nil)
1824 (form (read bytecomp-inbuffer)))
1825 ;; Warn about the use of old-style backquotes.
1826 (when old-style-backquotes
1827 (byte-compile-warn "!! The file uses old-style backquotes !!
1828 This functionality has been obsolete for more than 10 years already
1829 and will be removed soon. See (elisp)Backquote in the manual."))
1830 (byte-compile-file-form form)))
1831 ;; Compile pending forms at end of file.
1832 (byte-compile-flush-pending)
1833 ;; Make warnings about unresolved functions
1834 ;; give the end of the file as their position.
1835 (setq byte-compile-last-position (point-max))
1836 (byte-compile-warn-about-unresolved-functions))
1837 ;; Fix up the header at the front of the output
1838 ;; if the buffer contains multibyte characters.
1839 (and bytecomp-filename
1840 (with-current-buffer bytecomp-outbuffer
1841 (byte-compile-fix-header bytecomp-filename)))))
1842 bytecomp-outbuffer))
1843
1844 (defun byte-compile-fix-header (filename)
1845 "If the current buffer has any multibyte characters, insert a version test."
1846 (when (< (point-max) (position-bytes (point-max)))
1847 (goto-char (point-min))
1848 ;; Find the comment that describes the version condition.
1849 (search-forward "\n;;; This file uses")
1850 (narrow-to-region (line-beginning-position) (point-max))
1851 ;; Find the first line of ballast semicolons.
1852 (search-forward ";;;;;;;;;;")
1853 (beginning-of-line)
1854 (narrow-to-region (point-min) (point))
1855 (let ((old-header-end (point))
1856 (minimum-version "23")
1857 delta)
1858 (delete-region (point-min) (point-max))
1859 (insert
1860 ";;; This file contains utf-8 non-ASCII characters,\n"
1861 ";;; and so cannot be loaded into Emacs 22 or earlier.\n"
1862 ;; Have to check if emacs-version is bound so that this works
1863 ;; in files loaded early in loadup.el.
1864 "(and (boundp 'emacs-version)\n"
1865 ;; If there is a name at the end of emacs-version,
1866 ;; don't try to check the version number.
1867 " (< (aref emacs-version (1- (length emacs-version))) ?A)\n"
1868 (format " (string-lessp emacs-version \"%s\")\n" minimum-version)
1869 " (error \"`"
1870 ;; prin1-to-string is used to quote backslashes.
1871 (substring (prin1-to-string (file-name-nondirectory filename))
1872 1 -1)
1873 (format "' was compiled for Emacs %s or later\"))\n\n"
1874 minimum-version))
1875 ;; Now compensate for any change in size, to make sure all
1876 ;; positions in the file remain valid.
1877 (setq delta (- (point-max) old-header-end))
1878 (goto-char (point-max))
1879 (widen)
1880 (delete-char delta))))
1881
1882 (defun byte-compile-insert-header (filename outbuffer)
1883 "Insert a header at the start of OUTBUFFER.
1884 Call from the source buffer."
1885 (let ((dynamic-docstrings byte-compile-dynamic-docstrings)
1886 (dynamic byte-compile-dynamic)
1887 (optimize byte-optimize))
1888 (with-current-buffer outbuffer
1889 (goto-char (point-min))
1890 ;; The magic number of .elc files is ";ELC", or 0x3B454C43. After
1891 ;; that is the file-format version number (18, 19, 20, or 23) as a
1892 ;; byte, followed by some nulls. The primary motivation for doing
1893 ;; this is to get some binary characters up in the first line of
1894 ;; the file so that `diff' will simply say "Binary files differ"
1895 ;; instead of actually doing a diff of two .elc files. An extra
1896 ;; benefit is that you can add this to /etc/magic:
1897 ;; 0 string ;ELC GNU Emacs Lisp compiled file,
1898 ;; >4 byte x version %d
1899 (insert
1900 ";ELC" 23 "\000\000\000\n"
1901 ";;; Compiled by "
1902 (or (and (boundp 'user-mail-address) user-mail-address)
1903 (concat (user-login-name) "@" (system-name)))
1904 " on " (current-time-string) "\n"
1905 ";;; from file " filename "\n"
1906 ";;; in Emacs version " emacs-version "\n"
1907 ";;; with"
1908 (cond
1909 ((eq optimize 'source) " source-level optimization only")
1910 ((eq optimize 'byte) " byte-level optimization only")
1911 (optimize " all optimizations")
1912 (t "out optimization"))
1913 ".\n"
1914 (if dynamic ";;; Function definitions are lazy-loaded.\n"
1915 "")
1916 "\n;;; This file uses "
1917 (if dynamic-docstrings
1918 "dynamic docstrings, first added in Emacs 19.29"
1919 "opcodes that do not exist in Emacs 18")
1920 ".\n\n"
1921 ;; Note that byte-compile-fix-header may change this.
1922 ";;; This file does not contain utf-8 non-ASCII characters,\n"
1923 ";;; and so can be loaded in Emacs versions earlier than 23.\n\n"
1924 ;; Insert semicolons as ballast, so that byte-compile-fix-header
1925 ;; can delete them so as to keep the buffer positions
1926 ;; constant for the actual compiled code.
1927 ";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;\n"
1928 ";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;\n\n"))))
1929
1930 ;; Dynamically bound in byte-compile-from-buffer.
1931 ;; NB also used in cl.el and cl-macs.el.
1932 (defvar bytecomp-outbuffer)
1933
1934 (defun byte-compile-output-file-form (form)
1935 ;; writes the given form to the output buffer, being careful of docstrings
1936 ;; in defun, defmacro, defvar, defvaralias, defconst, autoload and
1937 ;; custom-declare-variable because make-docfile is so amazingly stupid.
1938 ;; defalias calls are output directly by byte-compile-file-form-defmumble;
1939 ;; it does not pay to first build the defalias in defmumble and then parse
1940 ;; it here.
1941 (if (and (memq (car-safe form) '(defun defmacro defvar defvaralias defconst autoload
1942 custom-declare-variable))
1943 (stringp (nth 3 form)))
1944 (byte-compile-output-docform nil nil '("\n(" 3 ")") form nil
1945 (memq (car form)
1946 '(defvaralias autoload
1947 custom-declare-variable)))
1948 (let ((print-escape-newlines t)
1949 (print-length nil)
1950 (print-level nil)
1951 (print-quoted t)
1952 (print-gensym t)
1953 (print-circle ; handle circular data structures
1954 (not byte-compile-disable-print-circle)))
1955 (princ "\n" bytecomp-outbuffer)
1956 (prin1 form bytecomp-outbuffer)
1957 nil)))
1958
1959 (defvar print-gensym-alist) ;Used before print-circle existed.
1960
1961 (defun byte-compile-output-docform (preface name info form specindex quoted)
1962 "Print a form with a doc string. INFO is (prefix doc-index postfix).
1963 If PREFACE and NAME are non-nil, print them too,
1964 before INFO and the FORM but after the doc string itself.
1965 If SPECINDEX is non-nil, it is the index in FORM
1966 of the function bytecode string. In that case,
1967 we output that argument and the following argument
1968 \(the constants vector) together, for lazy loading.
1969 QUOTED says that we have to put a quote before the
1970 list that represents a doc string reference.
1971 `defvaralias', `autoload' and `custom-declare-variable' need that."
1972 ;; We need to examine byte-compile-dynamic-docstrings
1973 ;; in the input buffer (now current), not in the output buffer.
1974 (let ((dynamic-docstrings byte-compile-dynamic-docstrings))
1975 (with-current-buffer bytecomp-outbuffer
1976 (let (position)
1977
1978 ;; Insert the doc string, and make it a comment with #@LENGTH.
1979 (and (>= (nth 1 info) 0)
1980 dynamic-docstrings
1981 (progn
1982 ;; Make the doc string start at beginning of line
1983 ;; for make-docfile's sake.
1984 (insert "\n")
1985 (setq position
1986 (byte-compile-output-as-comment
1987 (nth (nth 1 info) form) nil))
1988 (setq position (- (position-bytes position) (point-min) -1))
1989 ;; If the doc string starts with * (a user variable),
1990 ;; negate POSITION.
1991 (if (and (stringp (nth (nth 1 info) form))
1992 (> (length (nth (nth 1 info) form)) 0)
1993 (eq (aref (nth (nth 1 info) form) 0) ?*))
1994 (setq position (- position)))))
1995
1996 (if preface
1997 (progn
1998 (insert preface)
1999 (prin1 name bytecomp-outbuffer)))
2000 (insert (car info))
2001 (let ((print-escape-newlines t)
2002 (print-quoted t)
2003 ;; For compatibility with code before print-circle,
2004 ;; use a cons cell to say that we want
2005 ;; print-gensym-alist not to be cleared
2006 ;; between calls to print functions.
2007 (print-gensym '(t))
2008 (print-circle ; handle circular data structures
2009 (not byte-compile-disable-print-circle))
2010 print-gensym-alist ; was used before print-circle existed.
2011 (print-continuous-numbering t)
2012 print-number-table
2013 (index 0))
2014 (prin1 (car form) bytecomp-outbuffer)
2015 (while (setq form (cdr form))
2016 (setq index (1+ index))
2017 (insert " ")
2018 (cond ((and (numberp specindex) (= index specindex)
2019 ;; Don't handle the definition dynamically
2020 ;; if it refers (or might refer)
2021 ;; to objects already output
2022 ;; (for instance, gensyms in the arg list).
2023 (let (non-nil)
2024 (dotimes (i (length print-number-table))
2025 (if (aref print-number-table i)
2026 (setq non-nil t)))
2027 (not non-nil)))
2028 ;; Output the byte code and constants specially
2029 ;; for lazy dynamic loading.
2030 (let ((position
2031 (byte-compile-output-as-comment
2032 (cons (car form) (nth 1 form))
2033 t)))
2034 (setq position (- (position-bytes position) (point-min) -1))
2035 (princ (format "(#$ . %d) nil" position) bytecomp-outbuffer)
2036 (setq form (cdr form))
2037 (setq index (1+ index))))
2038 ((= index (nth 1 info))
2039 (if position
2040 (princ (format (if quoted "'(#$ . %d)" "(#$ . %d)")
2041 position)
2042 bytecomp-outbuffer)
2043 (let ((print-escape-newlines nil))
2044 (goto-char (prog1 (1+ (point))
2045 (prin1 (car form) bytecomp-outbuffer)))
2046 (insert "\\\n")
2047 (goto-char (point-max)))))
2048 (t
2049 (prin1 (car form) bytecomp-outbuffer)))))
2050 (insert (nth 2 info)))))
2051 nil)
2052
2053 (defun byte-compile-keep-pending (form &optional bytecomp-handler)
2054 (if (memq byte-optimize '(t source))
2055 (setq form (byte-optimize-form form t)))
2056 (if bytecomp-handler
2057 (let ((for-effect t))
2058 ;; To avoid consing up monstrously large forms at load time, we split
2059 ;; the output regularly.
2060 (and (memq (car-safe form) '(fset defalias))
2061 (nthcdr 300 byte-compile-output)
2062 (byte-compile-flush-pending))
2063 (funcall bytecomp-handler form)
2064 (if for-effect
2065 (byte-compile-discard)))
2066 (byte-compile-form form t))
2067 nil)
2068
2069 (defun byte-compile-flush-pending ()
2070 (if byte-compile-output
2071 (let ((form (byte-compile-out-toplevel t 'file)))
2072 (cond ((eq (car-safe form) 'progn)
2073 (mapc 'byte-compile-output-file-form (cdr form)))
2074 (form
2075 (byte-compile-output-file-form form)))
2076 (setq byte-compile-constants nil
2077 byte-compile-variables nil
2078 byte-compile-depth 0
2079 byte-compile-maxdepth 0
2080 byte-compile-output nil))))
2081
2082 (defun byte-compile-file-form (form)
2083 (let ((byte-compile-current-form nil) ; close over this for warnings.
2084 bytecomp-handler)
2085 (cond
2086 ((not (consp form))
2087 (byte-compile-keep-pending form))
2088 ((and (symbolp (car form))
2089 (setq bytecomp-handler (get (car form) 'byte-hunk-handler)))
2090 (cond ((setq form (funcall bytecomp-handler form))
2091 (byte-compile-flush-pending)
2092 (byte-compile-output-file-form form))))
2093 ((eq form (setq form (macroexpand form byte-compile-macro-environment)))
2094 (byte-compile-keep-pending form))
2095 (t
2096 (byte-compile-file-form form)))))
2097
2098 ;; Functions and variables with doc strings must be output separately,
2099 ;; so make-docfile can recognise them. Most other things can be output
2100 ;; as byte-code.
2101
2102 (put 'defsubst 'byte-hunk-handler 'byte-compile-file-form-defsubst)
2103 (defun byte-compile-file-form-defsubst (form)
2104 (when (assq (nth 1 form) byte-compile-unresolved-functions)
2105 (setq byte-compile-current-form (nth 1 form))
2106 (byte-compile-warn "defsubst `%s' was used before it was defined"
2107 (nth 1 form)))
2108 (byte-compile-file-form
2109 (macroexpand form byte-compile-macro-environment))
2110 ;; Return nil so the form is not output twice.
2111 nil)
2112
2113 (put 'autoload 'byte-hunk-handler 'byte-compile-file-form-autoload)
2114 (defun byte-compile-file-form-autoload (form)
2115 (and (let ((form form))
2116 (while (if (setq form (cdr form)) (byte-compile-constp (car form))))
2117 (null form)) ;Constants only
2118 (eval (nth 5 form)) ;Macro
2119 (eval form)) ;Define the autoload.
2120 ;; Avoid undefined function warnings for the autoload.
2121 (when (and (consp (nth 1 form))
2122 (eq (car (nth 1 form)) 'quote)
2123 (consp (cdr (nth 1 form)))
2124 (symbolp (nth 1 (nth 1 form))))
2125 (push (cons (nth 1 (nth 1 form))
2126 (cons 'autoload (cdr (cdr form))))
2127 byte-compile-function-environment)
2128 ;; If an autoload occurs _before_ the first call to a function,
2129 ;; byte-compile-callargs-warn does not add an entry to
2130 ;; byte-compile-unresolved-functions. Here we mimic the logic
2131 ;; of byte-compile-callargs-warn so as not to warn if the
2132 ;; autoload comes _after_ the function call.
2133 ;; Alternatively, similar logic could go in
2134 ;; byte-compile-warn-about-unresolved-functions.
2135 (or (memq (nth 1 (nth 1 form)) byte-compile-noruntime-functions)
2136 (setq byte-compile-unresolved-functions
2137 (delq (assq (nth 1 (nth 1 form))
2138 byte-compile-unresolved-functions)
2139 byte-compile-unresolved-functions))))
2140 (if (stringp (nth 3 form))
2141 form
2142 ;; No doc string, so we can compile this as a normal form.
2143 (byte-compile-keep-pending form 'byte-compile-normal-call)))
2144
2145 (put 'defvar 'byte-hunk-handler 'byte-compile-file-form-defvar)
2146 (put 'defconst 'byte-hunk-handler 'byte-compile-file-form-defvar)
2147 (defun byte-compile-file-form-defvar (form)
2148 (if (null (nth 3 form))
2149 ;; Since there is no doc string, we can compile this as a normal form,
2150 ;; and not do a file-boundary.
2151 (byte-compile-keep-pending form)
2152 (when (and (symbolp (nth 1 form))
2153 (not (string-match "[-*/:$]" (symbol-name (nth 1 form))))
2154 (byte-compile-warning-enabled-p 'lexical))
2155 (byte-compile-warn "global/dynamic var `%s' lacks a prefix"
2156 (nth 1 form)))
2157 (push (nth 1 form) byte-compile-bound-variables)
2158 (if (eq (car form) 'defconst)
2159 (push (nth 1 form) byte-compile-const-variables))
2160 (cond ((consp (nth 2 form))
2161 (setq form (copy-sequence form))
2162 (setcar (cdr (cdr form))
2163 (byte-compile-top-level (nth 2 form) nil 'file))))
2164 form))
2165
2166 (put 'define-abbrev-table 'byte-hunk-handler 'byte-compile-file-form-define-abbrev-table)
2167 (defun byte-compile-file-form-define-abbrev-table (form)
2168 (if (eq 'quote (car-safe (car-safe (cdr form))))
2169 (push (car-safe (cdr (cadr form))) byte-compile-bound-variables))
2170 (byte-compile-keep-pending form))
2171
2172 (put 'custom-declare-variable 'byte-hunk-handler
2173 'byte-compile-file-form-custom-declare-variable)
2174 (defun byte-compile-file-form-custom-declare-variable (form)
2175 (when (byte-compile-warning-enabled-p 'callargs)
2176 (byte-compile-nogroup-warn form))
2177 (push (nth 1 (nth 1 form)) byte-compile-bound-variables)
2178 ;; Don't compile the expression because it may be displayed to the user.
2179 ;; (when (eq (car-safe (nth 2 form)) 'quote)
2180 ;; ;; (nth 2 form) is meant to evaluate to an expression, so if we have the
2181 ;; ;; final value already, we can byte-compile it.
2182 ;; (setcar (cdr (nth 2 form))
2183 ;; (byte-compile-top-level (cadr (nth 2 form)) nil 'file)))
2184 (let ((tail (nthcdr 4 form)))
2185 (while tail
2186 (unless (keywordp (car tail)) ;No point optimizing keywords.
2187 ;; Compile the keyword arguments.
2188 (setcar tail (byte-compile-top-level (car tail) nil 'file)))
2189 (setq tail (cdr tail))))
2190 form)
2191
2192 (put 'require 'byte-hunk-handler 'byte-compile-file-form-require)
2193 (defun byte-compile-file-form-require (form)
2194 (let ((args (mapcar 'eval (cdr form)))
2195 (hist-orig load-history)
2196 hist-new)
2197 (apply 'require args)
2198 (when (byte-compile-warning-enabled-p 'cl-functions)
2199 ;; Detect (require 'cl) in a way that works even if cl is already loaded.
2200 (if (member (car args) '("cl" cl))
2201 (progn
2202 (byte-compile-warn "cl package required at runtime")
2203 (byte-compile-disable-warning 'cl-functions))
2204 ;; We may have required something that causes cl to be loaded, eg
2205 ;; the uncompiled version of a file that requires cl when compiling.
2206 (setq hist-new load-history)
2207 (while (and (not byte-compile-cl-functions)
2208 hist-new (not (eq hist-new hist-orig)))
2209 (and (byte-compile-cl-file-p (car (pop hist-new)))
2210 (byte-compile-find-cl-functions))))))
2211 (byte-compile-keep-pending form 'byte-compile-normal-call))
2212
2213 (put 'progn 'byte-hunk-handler 'byte-compile-file-form-progn)
2214 (put 'prog1 'byte-hunk-handler 'byte-compile-file-form-progn)
2215 (put 'prog2 'byte-hunk-handler 'byte-compile-file-form-progn)
2216 (defun byte-compile-file-form-progn (form)
2217 (mapc 'byte-compile-file-form (cdr form))
2218 ;; Return nil so the forms are not output twice.
2219 nil)
2220
2221 (put 'with-no-warnings 'byte-hunk-handler
2222 'byte-compile-file-form-with-no-warnings)
2223 (defun byte-compile-file-form-with-no-warnings (form)
2224 ;; cf byte-compile-file-form-progn.
2225 (let (byte-compile-warnings)
2226 (mapc 'byte-compile-file-form (cdr form))
2227 nil))
2228
2229 ;; This handler is not necessary, but it makes the output from dont-compile
2230 ;; and similar macros cleaner.
2231 (put 'eval 'byte-hunk-handler 'byte-compile-file-form-eval)
2232 (defun byte-compile-file-form-eval (form)
2233 (if (eq (car-safe (nth 1 form)) 'quote)
2234 (nth 1 (nth 1 form))
2235 (byte-compile-keep-pending form)))
2236
2237 (put 'defun 'byte-hunk-handler 'byte-compile-file-form-defun)
2238 (defun byte-compile-file-form-defun (form)
2239 (byte-compile-file-form-defmumble form nil))
2240
2241 (put 'defmacro 'byte-hunk-handler 'byte-compile-file-form-defmacro)
2242 (defun byte-compile-file-form-defmacro (form)
2243 (byte-compile-file-form-defmumble form t))
2244
2245 (defun byte-compile-defmacro-declaration (form)
2246 "Generate code for declarations in macro definitions.
2247 Remove declarations from the body of the macro definition
2248 by side-effects."
2249 (let ((tail (nthcdr 2 form))
2250 (res '()))
2251 (when (stringp (car (cdr tail)))
2252 (setq tail (cdr tail)))
2253 (while (and (consp (car (cdr tail)))
2254 (eq (car (car (cdr tail))) 'declare))
2255 (let ((declaration (car (cdr tail))))
2256 (setcdr tail (cdr (cdr tail)))
2257 (push `(if macro-declaration-function
2258 (funcall macro-declaration-function
2259 ',(car (cdr form)) ',declaration))
2260 res)))
2261 res))
2262
2263 (defun byte-compile-file-form-defmumble (form macrop)
2264 (let* ((bytecomp-name (car (cdr form)))
2265 (bytecomp-this-kind (if macrop 'byte-compile-macro-environment
2266 'byte-compile-function-environment))
2267 (bytecomp-that-kind (if macrop 'byte-compile-function-environment
2268 'byte-compile-macro-environment))
2269 (bytecomp-this-one (assq bytecomp-name
2270 (symbol-value bytecomp-this-kind)))
2271 (bytecomp-that-one (assq bytecomp-name
2272 (symbol-value bytecomp-that-kind)))
2273 (byte-compile-free-references nil)
2274 (byte-compile-free-assignments nil))
2275 (byte-compile-set-symbol-position bytecomp-name)
2276 ;; When a function or macro is defined, add it to the call tree so that
2277 ;; we can tell when functions are not used.
2278 (if byte-compile-generate-call-tree
2279 (or (assq bytecomp-name byte-compile-call-tree)
2280 (setq byte-compile-call-tree
2281 (cons (list bytecomp-name nil nil) byte-compile-call-tree))))
2282
2283 (setq byte-compile-current-form bytecomp-name) ; for warnings
2284 (if (byte-compile-warning-enabled-p 'redefine)
2285 (byte-compile-arglist-warn form macrop))
2286 (if byte-compile-verbose
2287 ;; bytecomp-filename is from byte-compile-from-buffer.
2288 (message "Compiling %s... (%s)" (or bytecomp-filename "") (nth 1 form)))
2289 (cond (bytecomp-that-one
2290 (if (and (byte-compile-warning-enabled-p 'redefine)
2291 ;; don't warn when compiling the stubs in byte-run...
2292 (not (assq (nth 1 form)
2293 byte-compile-initial-macro-environment)))
2294 (byte-compile-warn
2295 "`%s' defined multiple times, as both function and macro"
2296 (nth 1 form)))
2297 (setcdr bytecomp-that-one nil))
2298 (bytecomp-this-one
2299 (when (and (byte-compile-warning-enabled-p 'redefine)
2300 ;; hack: don't warn when compiling the magic internal
2301 ;; byte-compiler macros in byte-run.el...
2302 (not (assq (nth 1 form)
2303 byte-compile-initial-macro-environment)))
2304 (byte-compile-warn "%s `%s' defined multiple times in this file"
2305 (if macrop "macro" "function")
2306 (nth 1 form))))
2307 ((and (fboundp bytecomp-name)
2308 (eq (car-safe (symbol-function bytecomp-name))
2309 (if macrop 'lambda 'macro)))
2310 (when (byte-compile-warning-enabled-p 'redefine)
2311 (byte-compile-warn "%s `%s' being redefined as a %s"
2312 (if macrop "function" "macro")
2313 (nth 1 form)
2314 (if macrop "macro" "function")))
2315 ;; shadow existing definition
2316 (set bytecomp-this-kind
2317 (cons (cons bytecomp-name nil)
2318 (symbol-value bytecomp-this-kind))))
2319 )
2320 (let ((body (nthcdr 3 form)))
2321 (when (and (stringp (car body))
2322 (symbolp (car-safe (cdr-safe body)))
2323 (car-safe (cdr-safe body))
2324 (stringp (car-safe (cdr-safe (cdr-safe body)))))
2325 (byte-compile-set-symbol-position (nth 1 form))
2326 (byte-compile-warn "probable `\"' without `\\' in doc string of %s"
2327 (nth 1 form))))
2328
2329 ;; Generate code for declarations in macro definitions.
2330 ;; Remove declarations from the body of the macro definition.
2331 (when macrop
2332 (dolist (decl (byte-compile-defmacro-declaration form))
2333 (prin1 decl bytecomp-outbuffer)))
2334
2335 (let* ((new-one (byte-compile-lambda (nthcdr 2 form) t))
2336 (code (byte-compile-byte-code-maker new-one)))
2337 (if bytecomp-this-one
2338 (setcdr bytecomp-this-one new-one)
2339 (set bytecomp-this-kind
2340 (cons (cons bytecomp-name new-one)
2341 (symbol-value bytecomp-this-kind))))
2342 (if (and (stringp (nth 3 form))
2343 (eq 'quote (car-safe code))
2344 (eq 'lambda (car-safe (nth 1 code))))
2345 (cons (car form)
2346 (cons bytecomp-name (cdr (nth 1 code))))
2347 (byte-compile-flush-pending)
2348 (if (not (stringp (nth 3 form)))
2349 ;; No doc string. Provide -1 as the "doc string index"
2350 ;; so that no element will be treated as a doc string.
2351 (byte-compile-output-docform
2352 "\n(defalias '"
2353 bytecomp-name
2354 (cond ((atom code)
2355 (if macrop '(" '(macro . #[" -1 "])") '(" #[" -1 "]")))
2356 ((eq (car code) 'quote)
2357 (setq code new-one)
2358 (if macrop '(" '(macro " -1 ")") '(" '(" -1 ")")))
2359 ((if macrop '(" (cons 'macro (" -1 "))") '(" (" -1 ")"))))
2360 (append code nil)
2361 (and (atom code) byte-compile-dynamic
2362 1)
2363 nil)
2364 ;; Output the form by hand, that's much simpler than having
2365 ;; b-c-output-file-form analyze the defalias.
2366 (byte-compile-output-docform
2367 "\n(defalias '"
2368 bytecomp-name
2369 (cond ((atom code)
2370 (if macrop '(" '(macro . #[" 4 "])") '(" #[" 4 "]")))
2371 ((eq (car code) 'quote)
2372 (setq code new-one)
2373 (if macrop '(" '(macro " 2 ")") '(" '(" 2 ")")))
2374 ((if macrop '(" (cons 'macro (" 5 "))") '(" (" 5 ")"))))
2375 (append code nil)
2376 (and (atom code) byte-compile-dynamic
2377 1)
2378 nil))
2379 (princ ")" bytecomp-outbuffer)
2380 nil))))
2381
2382 ;; Print Lisp object EXP in the output file, inside a comment,
2383 ;; and return the file position it will have.
2384 ;; If QUOTED is non-nil, print with quoting; otherwise, print without quoting.
2385 (defun byte-compile-output-as-comment (exp quoted)
2386 (let ((position (point)))
2387 (with-current-buffer bytecomp-outbuffer
2388
2389 ;; Insert EXP, and make it a comment with #@LENGTH.
2390 (insert " ")
2391 (if quoted
2392 (prin1 exp bytecomp-outbuffer)
2393 (princ exp bytecomp-outbuffer))
2394 (goto-char position)
2395 ;; Quote certain special characters as needed.
2396 ;; get_doc_string in doc.c does the unquoting.
2397 (while (search-forward "\^A" nil t)
2398 (replace-match "\^A\^A" t t))
2399 (goto-char position)
2400 (while (search-forward "\000" nil t)
2401 (replace-match "\^A0" t t))
2402 (goto-char position)
2403 (while (search-forward "\037" nil t)
2404 (replace-match "\^A_" t t))
2405 (goto-char (point-max))
2406 (insert "\037")
2407 (goto-char position)
2408 (insert "#@" (format "%d" (- (position-bytes (point-max))
2409 (position-bytes position))))
2410
2411 ;; Save the file position of the object.
2412 ;; Note we should add 1 to skip the space
2413 ;; that we inserted before the actual doc string,
2414 ;; and subtract 1 to convert from an 1-origin Emacs position
2415 ;; to a file position; they cancel.
2416 (setq position (point))
2417 (goto-char (point-max)))
2418 position))
2419
2420
2421 \f
2422 ;;;###autoload
2423 (defun byte-compile (form)
2424 "If FORM is a symbol, byte-compile its function definition.
2425 If FORM is a lambda or a macro, byte-compile it as a function."
2426 (displaying-byte-compile-warnings
2427 (byte-compile-close-variables
2428 (let* ((fun (if (symbolp form)
2429 (and (fboundp form) (symbol-function form))
2430 form))
2431 (macro (eq (car-safe fun) 'macro)))
2432 (if macro
2433 (setq fun (cdr fun)))
2434 (cond ((eq (car-safe fun) 'lambda)
2435 (setq fun (if macro
2436 (cons 'macro (byte-compile-lambda fun))
2437 (byte-compile-lambda fun)))
2438 (if (symbolp form)
2439 (defalias form fun)
2440 fun)))))))
2441
2442 (defun byte-compile-sexp (sexp)
2443 "Compile and return SEXP."
2444 (displaying-byte-compile-warnings
2445 (byte-compile-close-variables
2446 (byte-compile-top-level sexp))))
2447
2448 ;; Given a function made by byte-compile-lambda, make a form which produces it.
2449 (defun byte-compile-byte-code-maker (fun)
2450 (cond
2451 ;; ## atom is faster than compiled-func-p.
2452 ((atom fun) ; compiled function.
2453 ;; generate-emacs19-bytecodes must be on, otherwise byte-compile-lambda
2454 ;; would have produced a lambda.
2455 fun)
2456 ;; b-c-lambda didn't produce a compiled-function, so it's either a trivial
2457 ;; function, or this is Emacs 18, or generate-emacs19-bytecodes is off.
2458 ((let (tmp)
2459 (if (and (setq tmp (assq 'byte-code (cdr-safe (cdr fun))))
2460 (null (cdr (memq tmp fun))))
2461 ;; Generate a make-byte-code call.
2462 (let* ((interactive (assq 'interactive (cdr (cdr fun)))))
2463 (nconc (list 'make-byte-code
2464 (list 'quote (nth 1 fun)) ;arglist
2465 (nth 1 tmp) ;bytes
2466 (nth 2 tmp) ;consts
2467 (nth 3 tmp)) ;depth
2468 (cond ((stringp (nth 2 fun))
2469 (list (nth 2 fun))) ;doc
2470 (interactive
2471 (list nil)))
2472 (cond (interactive
2473 (list (if (or (null (nth 1 interactive))
2474 (stringp (nth 1 interactive)))
2475 (nth 1 interactive)
2476 ;; Interactive spec is a list or a variable
2477 ;; (if it is correct).
2478 (list 'quote (nth 1 interactive))))))))
2479 ;; a non-compiled function (probably trivial)
2480 (list 'quote fun))))))
2481
2482 ;; Turn a function into an ordinary lambda. Needed for v18 files.
2483 (defun byte-compile-byte-code-unmake (function)
2484 (if (consp function)
2485 function;;It already is a lambda.
2486 (setq function (append function nil)) ; turn it into a list
2487 (nconc (list 'lambda (nth 0 function))
2488 (and (nth 4 function) (list (nth 4 function)))
2489 (if (nthcdr 5 function)
2490 (list (cons 'interactive (if (nth 5 function)
2491 (nthcdr 5 function)))))
2492 (list (list 'byte-code
2493 (nth 1 function) (nth 2 function)
2494 (nth 3 function))))))
2495
2496
2497 (defun byte-compile-check-lambda-list (list)
2498 "Check lambda-list LIST for errors."
2499 (let (vars)
2500 (while list
2501 (let ((arg (car list)))
2502 (when (symbolp arg)
2503 (byte-compile-set-symbol-position arg))
2504 (cond ((or (not (symbolp arg))
2505 (byte-compile-const-symbol-p arg t))
2506 (error "Invalid lambda variable %s" arg))
2507 ((eq arg '&rest)
2508 (unless (cdr list)
2509 (error "&rest without variable name"))
2510 (when (cddr list)
2511 (error "Garbage following &rest VAR in lambda-list")))
2512 ((eq arg '&optional)
2513 (unless (cdr list)
2514 (error "Variable name missing after &optional")))
2515 ((memq arg vars)
2516 (byte-compile-warn "repeated variable %s in lambda-list" arg))
2517 (t
2518 (push arg vars))))
2519 (setq list (cdr list)))))
2520
2521
2522 ;; Byte-compile a lambda-expression and return a valid function.
2523 ;; The value is usually a compiled function but may be the original
2524 ;; lambda-expression.
2525 ;; When ADD-LAMBDA is non-nil, the symbol `lambda' is added as head
2526 ;; of the list FUN and `byte-compile-set-symbol-position' is not called.
2527 ;; Use this feature to avoid calling `byte-compile-set-symbol-position'
2528 ;; for symbols generated by the byte compiler itself.
2529 (defun byte-compile-lambda (bytecomp-fun &optional add-lambda)
2530 (if add-lambda
2531 (setq bytecomp-fun (cons 'lambda bytecomp-fun))
2532 (unless (eq 'lambda (car-safe bytecomp-fun))
2533 (error "Not a lambda list: %S" bytecomp-fun))
2534 (byte-compile-set-symbol-position 'lambda))
2535 (byte-compile-check-lambda-list (nth 1 bytecomp-fun))
2536 (let* ((bytecomp-arglist (nth 1 bytecomp-fun))
2537 (byte-compile-bound-variables
2538 (nconc (and (byte-compile-warning-enabled-p 'free-vars)
2539 (delq '&rest
2540 (delq '&optional (copy-sequence bytecomp-arglist))))
2541 byte-compile-bound-variables))
2542 (bytecomp-body (cdr (cdr bytecomp-fun)))
2543 (bytecomp-doc (if (stringp (car bytecomp-body))
2544 (prog1 (car bytecomp-body)
2545 ;; Discard the doc string
2546 ;; unless it is the last element of the body.
2547 (if (cdr bytecomp-body)
2548 (setq bytecomp-body (cdr bytecomp-body))))))
2549 (bytecomp-int (assq 'interactive bytecomp-body)))
2550 ;; Process the interactive spec.
2551 (when bytecomp-int
2552 (byte-compile-set-symbol-position 'interactive)
2553 ;; Skip (interactive) if it is in front (the most usual location).
2554 (if (eq bytecomp-int (car bytecomp-body))
2555 (setq bytecomp-body (cdr bytecomp-body)))
2556 (cond ((consp (cdr bytecomp-int))
2557 (if (cdr (cdr bytecomp-int))
2558 (byte-compile-warn "malformed interactive spec: %s"
2559 (prin1-to-string bytecomp-int)))
2560 ;; If the interactive spec is a call to `list', don't
2561 ;; compile it, because `call-interactively' looks at the
2562 ;; args of `list'. Actually, compile it to get warnings,
2563 ;; but don't use the result.
2564 (let ((form (nth 1 bytecomp-int)))
2565 (while (memq (car-safe form) '(let let* progn save-excursion))
2566 (while (consp (cdr form))
2567 (setq form (cdr form)))
2568 (setq form (car form)))
2569 (if (eq (car-safe form) 'list)
2570 (byte-compile-top-level (nth 1 bytecomp-int))
2571 (setq bytecomp-int (list 'interactive
2572 (byte-compile-top-level
2573 (nth 1 bytecomp-int)))))))
2574 ((cdr bytecomp-int)
2575 (byte-compile-warn "malformed interactive spec: %s"
2576 (prin1-to-string bytecomp-int)))))
2577 ;; Process the body.
2578 (let ((compiled (byte-compile-top-level
2579 (cons 'progn bytecomp-body) nil 'lambda)))
2580 ;; Build the actual byte-coded function.
2581 (if (eq 'byte-code (car-safe compiled))
2582 (apply 'make-byte-code
2583 (append (list bytecomp-arglist)
2584 ;; byte-string, constants-vector, stack depth
2585 (cdr compiled)
2586 ;; optionally, the doc string.
2587 (if (or bytecomp-doc bytecomp-int)
2588 (list bytecomp-doc))
2589 ;; optionally, the interactive spec.
2590 (if bytecomp-int
2591 (list (nth 1 bytecomp-int)))))
2592 (setq compiled
2593 (nconc (if bytecomp-int (list bytecomp-int))
2594 (cond ((eq (car-safe compiled) 'progn) (cdr compiled))
2595 (compiled (list compiled)))))
2596 (nconc (list 'lambda bytecomp-arglist)
2597 (if (or bytecomp-doc (stringp (car compiled)))
2598 (cons bytecomp-doc (cond (compiled)
2599 (bytecomp-body (list nil))))
2600 compiled))))))
2601
2602 (defun byte-compile-constants-vector ()
2603 ;; Builds the constants-vector from the current variables and constants.
2604 ;; This modifies the constants from (const . nil) to (const . offset).
2605 ;; To keep the byte-codes to look up the vector as short as possible:
2606 ;; First 6 elements are vars, as there are one-byte varref codes for those.
2607 ;; Next up to byte-constant-limit are constants, still with one-byte codes.
2608 ;; Next variables again, to get 2-byte codes for variable lookup.
2609 ;; The rest of the constants and variables need 3-byte byte-codes.
2610 (let* ((i -1)
2611 (rest (nreverse byte-compile-variables)) ; nreverse because the first
2612 (other (nreverse byte-compile-constants)) ; vars often are used most.
2613 ret tmp
2614 (limits '(5 ; Use the 1-byte varref codes,
2615 63 ; 1-constlim ; 1-byte byte-constant codes,
2616 255 ; 2-byte varref codes,
2617 65535)) ; 3-byte codes for the rest.
2618 limit)
2619 (while (or rest other)
2620 (setq limit (car limits))
2621 (while (and rest (not (eq i limit)))
2622 (if (setq tmp (assq (car (car rest)) ret))
2623 (setcdr (car rest) (cdr tmp))
2624 (setcdr (car rest) (setq i (1+ i)))
2625 (setq ret (cons (car rest) ret)))
2626 (setq rest (cdr rest)))
2627 (setq limits (cdr limits)
2628 rest (prog1 other
2629 (setq other rest))))
2630 (apply 'vector (nreverse (mapcar 'car ret)))))
2631
2632 ;; Given an expression FORM, compile it and return an equivalent byte-code
2633 ;; expression (a call to the function byte-code).
2634 (defun byte-compile-top-level (form &optional for-effect output-type)
2635 ;; OUTPUT-TYPE advises about how form is expected to be used:
2636 ;; 'eval or nil -> a single form,
2637 ;; 'progn or t -> a list of forms,
2638 ;; 'lambda -> body of a lambda,
2639 ;; 'file -> used at file-level.
2640 (let ((byte-compile-constants nil)
2641 (byte-compile-variables nil)
2642 (byte-compile-tag-number 0)
2643 (byte-compile-depth 0)
2644 (byte-compile-maxdepth 0)
2645 (byte-compile-output nil))
2646 (if (memq byte-optimize '(t source))
2647 (setq form (byte-optimize-form form for-effect)))
2648 (while (and (eq (car-safe form) 'progn) (null (cdr (cdr form))))
2649 (setq form (nth 1 form)))
2650 (if (and (eq 'byte-code (car-safe form))
2651 (not (memq byte-optimize '(t byte)))
2652 (stringp (nth 1 form)) (vectorp (nth 2 form))
2653 (natnump (nth 3 form)))
2654 form
2655 (byte-compile-form form for-effect)
2656 (byte-compile-out-toplevel for-effect output-type))))
2657
2658 (defun byte-compile-out-toplevel (&optional for-effect output-type)
2659 (if for-effect
2660 ;; The stack is empty. Push a value to be returned from (byte-code ..).
2661 (if (eq (car (car byte-compile-output)) 'byte-discard)
2662 (setq byte-compile-output (cdr byte-compile-output))
2663 (byte-compile-push-constant
2664 ;; Push any constant - preferably one which already is used, and
2665 ;; a number or symbol - ie not some big sequence. The return value
2666 ;; isn't returned, but it would be a shame if some textually large
2667 ;; constant was not optimized away because we chose to return it.
2668 (and (not (assq nil byte-compile-constants)) ; Nil is often there.
2669 (let ((tmp (reverse byte-compile-constants)))
2670 (while (and tmp (not (or (symbolp (caar tmp))
2671 (numberp (caar tmp)))))
2672 (setq tmp (cdr tmp)))
2673 (caar tmp))))))
2674 (byte-compile-out 'byte-return 0)
2675 (setq byte-compile-output (nreverse byte-compile-output))
2676 (if (memq byte-optimize '(t byte))
2677 (setq byte-compile-output
2678 (byte-optimize-lapcode byte-compile-output for-effect)))
2679
2680 ;; Decompile trivial functions:
2681 ;; only constants and variables, or a single funcall except in lambdas.
2682 ;; Except for Lisp_Compiled objects, forms like (foo "hi")
2683 ;; are still quicker than (byte-code "..." [foo "hi"] 2).
2684 ;; Note that even (quote foo) must be parsed just as any subr by the
2685 ;; interpreter, so quote should be compiled into byte-code in some contexts.
2686 ;; What to leave uncompiled:
2687 ;; lambda -> never. we used to leave it uncompiled if the body was
2688 ;; a single atom, but that causes confusion if the docstring
2689 ;; uses the (file . pos) syntax. Besides, now that we have
2690 ;; the Lisp_Compiled type, the compiled form is faster.
2691 ;; eval -> atom, quote or (function atom atom atom)
2692 ;; progn -> as <<same-as-eval>> or (progn <<same-as-eval>> atom)
2693 ;; file -> as progn, but takes both quotes and atoms, and longer forms.
2694 (let (rest
2695 (maycall (not (eq output-type 'lambda))) ; t if we may make a funcall.
2696 tmp body)
2697 (cond
2698 ;; #### This should be split out into byte-compile-nontrivial-function-p.
2699 ((or (eq output-type 'lambda)
2700 (nthcdr (if (eq output-type 'file) 50 8) byte-compile-output)
2701 (assq 'TAG byte-compile-output) ; Not necessary, but speeds up a bit.
2702 (not (setq tmp (assq 'byte-return byte-compile-output)))
2703 (progn
2704 (setq rest (nreverse
2705 (cdr (memq tmp (reverse byte-compile-output)))))
2706 (while (cond
2707 ((memq (car (car rest)) '(byte-varref byte-constant))
2708 (setq tmp (car (cdr (car rest))))
2709 (if (if (eq (car (car rest)) 'byte-constant)
2710 (or (consp tmp)
2711 (and (symbolp tmp)
2712 (not (byte-compile-const-symbol-p tmp)))))
2713 (if maycall
2714 (setq body (cons (list 'quote tmp) body)))
2715 (setq body (cons tmp body))))
2716 ((and maycall
2717 ;; Allow a funcall if at most one atom follows it.
2718 (null (nthcdr 3 rest))
2719 (setq tmp (get (car (car rest)) 'byte-opcode-invert))
2720 (or (null (cdr rest))
2721 (and (memq output-type '(file progn t))
2722 (cdr (cdr rest))
2723 (eq (car (nth 1 rest)) 'byte-discard)
2724 (progn (setq rest (cdr rest)) t))))
2725 (setq maycall nil) ; Only allow one real function call.
2726 (setq body (nreverse body))
2727 (setq body (list
2728 (if (and (eq tmp 'funcall)
2729 (eq (car-safe (car body)) 'quote))
2730 (cons (nth 1 (car body)) (cdr body))
2731 (cons tmp body))))
2732 (or (eq output-type 'file)
2733 (not (delq nil (mapcar 'consp (cdr (car body))))))))
2734 (setq rest (cdr rest)))
2735 rest))
2736 (let ((byte-compile-vector (byte-compile-constants-vector)))
2737 (list 'byte-code (byte-compile-lapcode byte-compile-output)
2738 byte-compile-vector byte-compile-maxdepth)))
2739 ;; it's a trivial function
2740 ((cdr body) (cons 'progn (nreverse body)))
2741 ((car body)))))
2742
2743 ;; Given BYTECOMP-BODY, compile it and return a new body.
2744 (defun byte-compile-top-level-body (bytecomp-body &optional for-effect)
2745 (setq bytecomp-body
2746 (byte-compile-top-level (cons 'progn bytecomp-body) for-effect t))
2747 (cond ((eq (car-safe bytecomp-body) 'progn)
2748 (cdr bytecomp-body))
2749 (bytecomp-body
2750 (list bytecomp-body))))
2751
2752 (put 'declare-function 'byte-hunk-handler 'byte-compile-declare-function)
2753 (defun byte-compile-declare-function (form)
2754 (push (cons (nth 1 form)
2755 (if (and (> (length form) 3)
2756 (listp (nth 3 form)))
2757 (list 'declared (nth 3 form))
2758 t)) ; arglist not specified
2759 byte-compile-function-environment)
2760 ;; We are stating that it _will_ be defined at runtime.
2761 (setq byte-compile-noruntime-functions
2762 (delq (nth 1 form) byte-compile-noruntime-functions))
2763 nil)
2764
2765 \f
2766 ;; This is the recursive entry point for compiling each subform of an
2767 ;; expression.
2768 ;; If for-effect is non-nil, byte-compile-form will output a byte-discard
2769 ;; before terminating (ie no value will be left on the stack).
2770 ;; A byte-compile handler may, when for-effect is non-nil, choose output code
2771 ;; which does not leave a value on the stack, and then set for-effect to nil
2772 ;; (to prevent byte-compile-form from outputting the byte-discard).
2773 ;; If a handler wants to call another handler, it should do so via
2774 ;; byte-compile-form, or take extreme care to handle for-effect correctly.
2775 ;; (Use byte-compile-form-do-effect to reset the for-effect flag too.)
2776 ;;
2777 (defun byte-compile-form (form &optional for-effect)
2778 (setq form (macroexpand form byte-compile-macro-environment))
2779 (cond ((not (consp form))
2780 (cond ((or (not (symbolp form)) (byte-compile-const-symbol-p form))
2781 (when (symbolp form)
2782 (byte-compile-set-symbol-position form))
2783 (byte-compile-constant form))
2784 ((and for-effect byte-compile-delete-errors)
2785 (when (symbolp form)
2786 (byte-compile-set-symbol-position form))
2787 (setq for-effect nil))
2788 (t (byte-compile-variable-ref 'byte-varref form))))
2789 ((symbolp (car form))
2790 (let* ((bytecomp-fn (car form))
2791 (bytecomp-handler (get bytecomp-fn 'byte-compile)))
2792 (when (byte-compile-const-symbol-p bytecomp-fn)
2793 (byte-compile-warn "`%s' called as a function" bytecomp-fn))
2794 (and (byte-compile-warning-enabled-p 'interactive-only)
2795 (memq bytecomp-fn byte-compile-interactive-only-functions)
2796 (byte-compile-warn "`%s' used from Lisp code\n\
2797 That command is designed for interactive use only" bytecomp-fn))
2798 (when (byte-compile-warning-enabled-p 'callargs)
2799 (if (memq bytecomp-fn
2800 '(custom-declare-group custom-declare-variable
2801 custom-declare-face))
2802 (byte-compile-nogroup-warn form))
2803 (byte-compile-callargs-warn form))
2804 (if (and bytecomp-handler
2805 ;; Make sure that function exists. This is important
2806 ;; for CL compiler macros since the symbol may be
2807 ;; `cl-byte-compile-compiler-macro' but if CL isn't
2808 ;; loaded, this function doesn't exist.
2809 (or (not (memq bytecomp-handler
2810 '(cl-byte-compile-compiler-macro)))
2811 (functionp bytecomp-handler)))
2812 (funcall bytecomp-handler form)
2813 (byte-compile-normal-call form))
2814 (if (byte-compile-warning-enabled-p 'cl-functions)
2815 (byte-compile-cl-warn form))))
2816 ((and (or (byte-code-function-p (car form))
2817 (eq (car-safe (car form)) 'lambda))
2818 ;; if the form comes out the same way it went in, that's
2819 ;; because it was malformed, and we couldn't unfold it.
2820 (not (eq form (setq form (byte-compile-unfold-lambda form)))))
2821 (byte-compile-form form for-effect)
2822 (setq for-effect nil))
2823 ((byte-compile-normal-call form)))
2824 (if for-effect
2825 (byte-compile-discard)))
2826
2827 (defun byte-compile-normal-call (form)
2828 (if byte-compile-generate-call-tree
2829 (byte-compile-annotate-call-tree form))
2830 (when (and for-effect (eq (car form) 'mapcar)
2831 (byte-compile-warning-enabled-p 'mapcar))
2832 (byte-compile-set-symbol-position 'mapcar)
2833 (byte-compile-warn
2834 "`mapcar' called for effect; use `mapc' or `dolist' instead"))
2835 (byte-compile-push-constant (car form))
2836 (mapc 'byte-compile-form (cdr form)) ; wasteful, but faster.
2837 (byte-compile-out 'byte-call (length (cdr form))))
2838
2839 (defun byte-compile-variable-ref (base-op bytecomp-var)
2840 (when (symbolp bytecomp-var)
2841 (byte-compile-set-symbol-position bytecomp-var))
2842 (if (or (not (symbolp bytecomp-var))
2843 (byte-compile-const-symbol-p bytecomp-var
2844 (not (eq base-op 'byte-varref))))
2845 (if (byte-compile-warning-enabled-p 'constants)
2846 (byte-compile-warn
2847 (cond ((eq base-op 'byte-varbind) "attempt to let-bind %s `%s'")
2848 ((eq base-op 'byte-varset) "variable assignment to %s `%s'")
2849 (t "variable reference to %s `%s'"))
2850 (if (symbolp bytecomp-var) "constant" "nonvariable")
2851 (prin1-to-string bytecomp-var)))
2852 (and (get bytecomp-var 'byte-obsolete-variable)
2853 (not (memq bytecomp-var byte-compile-not-obsolete-vars))
2854 (byte-compile-warn-obsolete bytecomp-var))
2855 (if (eq base-op 'byte-varbind)
2856 (push bytecomp-var byte-compile-bound-variables)
2857 (or (not (byte-compile-warning-enabled-p 'free-vars))
2858 (boundp bytecomp-var)
2859 (memq bytecomp-var byte-compile-bound-variables)
2860 (if (eq base-op 'byte-varset)
2861 (or (memq bytecomp-var byte-compile-free-assignments)
2862 (progn
2863 (byte-compile-warn "assignment to free variable `%s'"
2864 bytecomp-var)
2865 (push bytecomp-var byte-compile-free-assignments)))
2866 (or (memq bytecomp-var byte-compile-free-references)
2867 (progn
2868 (byte-compile-warn "reference to free variable `%s'"
2869 bytecomp-var)
2870 (push bytecomp-var byte-compile-free-references)))))))
2871 (let ((tmp (assq bytecomp-var byte-compile-variables)))
2872 (unless tmp
2873 (setq tmp (list bytecomp-var))
2874 (push tmp byte-compile-variables))
2875 (byte-compile-out base-op tmp)))
2876
2877 (defmacro byte-compile-get-constant (const)
2878 `(or (if (stringp ,const)
2879 ;; In a string constant, treat properties as significant.
2880 (let (result)
2881 (dolist (elt byte-compile-constants)
2882 (if (equal-including-properties (car elt) ,const)
2883 (setq result elt)))
2884 result)
2885 (assq ,const byte-compile-constants))
2886 (car (setq byte-compile-constants
2887 (cons (list ,const) byte-compile-constants)))))
2888
2889 ;; Use this when the value of a form is a constant. This obeys for-effect.
2890 (defun byte-compile-constant (const)
2891 (if for-effect
2892 (setq for-effect nil)
2893 (when (symbolp const)
2894 (byte-compile-set-symbol-position const))
2895 (byte-compile-out 'byte-constant (byte-compile-get-constant const))))
2896
2897 ;; Use this for a constant that is not the value of its containing form.
2898 ;; This ignores for-effect.
2899 (defun byte-compile-push-constant (const)
2900 (let ((for-effect nil))
2901 (inline (byte-compile-constant const))))
2902
2903 \f
2904 ;; Compile those primitive ordinary functions
2905 ;; which have special byte codes just for speed.
2906
2907 (defmacro byte-defop-compiler (function &optional compile-handler)
2908 "Add a compiler-form for FUNCTION.
2909 If function is a symbol, then the variable \"byte-SYMBOL\" must name
2910 the opcode to be used. If function is a list, the first element
2911 is the function and the second element is the bytecode-symbol.
2912 The second element may be nil, meaning there is no opcode.
2913 COMPILE-HANDLER is the function to use to compile this byte-op, or
2914 may be the abbreviations 0, 1, 2, 3, 0-1, or 1-2.
2915 If it is nil, then the handler is \"byte-compile-SYMBOL.\""
2916 (let (opcode)
2917 (if (symbolp function)
2918 (setq opcode (intern (concat "byte-" (symbol-name function))))
2919 (setq opcode (car (cdr function))
2920 function (car function)))
2921 (let ((fnform
2922 (list 'put (list 'quote function) ''byte-compile
2923 (list 'quote
2924 (or (cdr (assq compile-handler
2925 '((0 . byte-compile-no-args)
2926 (1 . byte-compile-one-arg)
2927 (2 . byte-compile-two-args)
2928 (3 . byte-compile-three-args)
2929 (0-1 . byte-compile-zero-or-one-arg)
2930 (1-2 . byte-compile-one-or-two-args)
2931 (2-3 . byte-compile-two-or-three-args)
2932 )))
2933 compile-handler
2934 (intern (concat "byte-compile-"
2935 (symbol-name function))))))))
2936 (if opcode
2937 (list 'progn fnform
2938 (list 'put (list 'quote function)
2939 ''byte-opcode (list 'quote opcode))
2940 (list 'put (list 'quote opcode)
2941 ''byte-opcode-invert (list 'quote function)))
2942 fnform))))
2943
2944 (defmacro byte-defop-compiler-1 (function &optional compile-handler)
2945 (list 'byte-defop-compiler (list function nil) compile-handler))
2946
2947 \f
2948 (put 'byte-call 'byte-opcode-invert 'funcall)
2949 (put 'byte-list1 'byte-opcode-invert 'list)
2950 (put 'byte-list2 'byte-opcode-invert 'list)
2951 (put 'byte-list3 'byte-opcode-invert 'list)
2952 (put 'byte-list4 'byte-opcode-invert 'list)
2953 (put 'byte-listN 'byte-opcode-invert 'list)
2954 (put 'byte-concat2 'byte-opcode-invert 'concat)
2955 (put 'byte-concat3 'byte-opcode-invert 'concat)
2956 (put 'byte-concat4 'byte-opcode-invert 'concat)
2957 (put 'byte-concatN 'byte-opcode-invert 'concat)
2958 (put 'byte-insertN 'byte-opcode-invert 'insert)
2959
2960 (byte-defop-compiler point 0)
2961 ;;(byte-defop-compiler mark 0) ;; obsolete
2962 (byte-defop-compiler point-max 0)
2963 (byte-defop-compiler point-min 0)
2964 (byte-defop-compiler following-char 0)
2965 (byte-defop-compiler preceding-char 0)
2966 (byte-defop-compiler current-column 0)
2967 (byte-defop-compiler eolp 0)
2968 (byte-defop-compiler eobp 0)
2969 (byte-defop-compiler bolp 0)
2970 (byte-defop-compiler bobp 0)
2971 (byte-defop-compiler current-buffer 0)
2972 ;;(byte-defop-compiler read-char 0) ;; obsolete
2973 (byte-defop-compiler interactive-p 0)
2974 (byte-defop-compiler widen 0)
2975 (byte-defop-compiler end-of-line 0-1)
2976 (byte-defop-compiler forward-char 0-1)
2977 (byte-defop-compiler forward-line 0-1)
2978 (byte-defop-compiler symbolp 1)
2979 (byte-defop-compiler consp 1)
2980 (byte-defop-compiler stringp 1)
2981 (byte-defop-compiler listp 1)
2982 (byte-defop-compiler not 1)
2983 (byte-defop-compiler (null byte-not) 1)
2984 (byte-defop-compiler car 1)
2985 (byte-defop-compiler cdr 1)
2986 (byte-defop-compiler length 1)
2987 (byte-defop-compiler symbol-value 1)
2988 (byte-defop-compiler symbol-function 1)
2989 (byte-defop-compiler (1+ byte-add1) 1)
2990 (byte-defop-compiler (1- byte-sub1) 1)
2991 (byte-defop-compiler goto-char 1)
2992 (byte-defop-compiler char-after 0-1)
2993 (byte-defop-compiler set-buffer 1)
2994 ;;(byte-defop-compiler set-mark 1) ;; obsolete
2995 (byte-defop-compiler forward-word 0-1)
2996 (byte-defop-compiler char-syntax 1)
2997 (byte-defop-compiler nreverse 1)
2998 (byte-defop-compiler car-safe 1)
2999 (byte-defop-compiler cdr-safe 1)
3000 (byte-defop-compiler numberp 1)
3001 (byte-defop-compiler integerp 1)
3002 (byte-defop-compiler skip-chars-forward 1-2)
3003 (byte-defop-compiler skip-chars-backward 1-2)
3004 (byte-defop-compiler eq 2)
3005 (byte-defop-compiler memq 2)
3006 (byte-defop-compiler cons 2)
3007 (byte-defop-compiler aref 2)
3008 (byte-defop-compiler set 2)
3009 (byte-defop-compiler (= byte-eqlsign) 2)
3010 (byte-defop-compiler (< byte-lss) 2)
3011 (byte-defop-compiler (> byte-gtr) 2)
3012 (byte-defop-compiler (<= byte-leq) 2)
3013 (byte-defop-compiler (>= byte-geq) 2)
3014 (byte-defop-compiler get 2)
3015 (byte-defop-compiler nth 2)
3016 (byte-defop-compiler substring 2-3)
3017 (byte-defop-compiler (move-marker byte-set-marker) 2-3)
3018 (byte-defop-compiler set-marker 2-3)
3019 (byte-defop-compiler match-beginning 1)
3020 (byte-defop-compiler match-end 1)
3021 (byte-defop-compiler upcase 1)
3022 (byte-defop-compiler downcase 1)
3023 (byte-defop-compiler string= 2)
3024 (byte-defop-compiler string< 2)
3025 (byte-defop-compiler (string-equal byte-string=) 2)
3026 (byte-defop-compiler (string-lessp byte-string<) 2)
3027 (byte-defop-compiler equal 2)
3028 (byte-defop-compiler nthcdr 2)
3029 (byte-defop-compiler elt 2)
3030 (byte-defop-compiler member 2)
3031 (byte-defop-compiler assq 2)
3032 (byte-defop-compiler (rplaca byte-setcar) 2)
3033 (byte-defop-compiler (rplacd byte-setcdr) 2)
3034 (byte-defop-compiler setcar 2)
3035 (byte-defop-compiler setcdr 2)
3036 (byte-defop-compiler buffer-substring 2)
3037 (byte-defop-compiler delete-region 2)
3038 (byte-defop-compiler narrow-to-region 2)
3039 (byte-defop-compiler (% byte-rem) 2)
3040 (byte-defop-compiler aset 3)
3041
3042 (byte-defop-compiler max byte-compile-associative)
3043 (byte-defop-compiler min byte-compile-associative)
3044 (byte-defop-compiler (+ byte-plus) byte-compile-associative)
3045 (byte-defop-compiler (* byte-mult) byte-compile-associative)
3046
3047 ;;####(byte-defop-compiler move-to-column 1)
3048 (byte-defop-compiler-1 interactive byte-compile-noop)
3049
3050 \f
3051 (defun byte-compile-subr-wrong-args (form n)
3052 (byte-compile-set-symbol-position (car form))
3053 (byte-compile-warn "`%s' called with %d arg%s, but requires %s"
3054 (car form) (length (cdr form))
3055 (if (= 1 (length (cdr form))) "" "s") n)
3056 ;; get run-time wrong-number-of-args error.
3057 (byte-compile-normal-call form))
3058
3059 (defun byte-compile-no-args (form)
3060 (if (not (= (length form) 1))
3061 (byte-compile-subr-wrong-args form "none")
3062 (byte-compile-out (get (car form) 'byte-opcode) 0)))
3063
3064 (defun byte-compile-one-arg (form)
3065 (if (not (= (length form) 2))
3066 (byte-compile-subr-wrong-args form 1)
3067 (byte-compile-form (car (cdr form))) ;; Push the argument
3068 (byte-compile-out (get (car form) 'byte-opcode) 0)))
3069
3070 (defun byte-compile-two-args (form)
3071 (if (not (= (length form) 3))
3072 (byte-compile-subr-wrong-args form 2)
3073 (byte-compile-form (car (cdr form))) ;; Push the arguments
3074 (byte-compile-form (nth 2 form))
3075 (byte-compile-out (get (car form) 'byte-opcode) 0)))
3076
3077 (defun byte-compile-three-args (form)
3078 (if (not (= (length form) 4))
3079 (byte-compile-subr-wrong-args form 3)
3080 (byte-compile-form (car (cdr form))) ;; Push the arguments
3081 (byte-compile-form (nth 2 form))
3082 (byte-compile-form (nth 3 form))
3083 (byte-compile-out (get (car form) 'byte-opcode) 0)))
3084
3085 (defun byte-compile-zero-or-one-arg (form)
3086 (let ((len (length form)))
3087 (cond ((= len 1) (byte-compile-one-arg (append form '(nil))))
3088 ((= len 2) (byte-compile-one-arg form))
3089 (t (byte-compile-subr-wrong-args form "0-1")))))
3090
3091 (defun byte-compile-one-or-two-args (form)
3092 (let ((len (length form)))
3093 (cond ((= len 2) (byte-compile-two-args (append form '(nil))))
3094 ((= len 3) (byte-compile-two-args form))
3095 (t (byte-compile-subr-wrong-args form "1-2")))))
3096
3097 (defun byte-compile-two-or-three-args (form)
3098 (let ((len (length form)))
3099 (cond ((= len 3) (byte-compile-three-args (append form '(nil))))
3100 ((= len 4) (byte-compile-three-args form))
3101 (t (byte-compile-subr-wrong-args form "2-3")))))
3102
3103 (defun byte-compile-noop (form)
3104 (byte-compile-constant nil))
3105
3106 (defun byte-compile-discard ()
3107 (byte-compile-out 'byte-discard 0))
3108
3109
3110 ;; Compile a function that accepts one or more args and is right-associative.
3111 ;; We do it by left-associativity so that the operations
3112 ;; are done in the same order as in interpreted code.
3113 ;; We treat the one-arg case, as in (+ x), like (+ x 0).
3114 ;; in order to convert markers to numbers, and trigger expected errors.
3115 (defun byte-compile-associative (form)
3116 (if (cdr form)
3117 (let ((opcode (get (car form) 'byte-opcode))
3118 args)
3119 (if (and (< 3 (length form))
3120 (memq opcode (list (get '+ 'byte-opcode)
3121 (get '* 'byte-opcode))))
3122 ;; Don't use binary operations for > 2 operands, as that
3123 ;; may cause overflow/truncation in float operations.
3124 (byte-compile-normal-call form)
3125 (setq args (copy-sequence (cdr form)))
3126 (byte-compile-form (car args))
3127 (setq args (cdr args))
3128 (or args (setq args '(0)
3129 opcode (get '+ 'byte-opcode)))
3130 (dolist (arg args)
3131 (byte-compile-form arg)
3132 (byte-compile-out opcode 0))))
3133 (byte-compile-constant (eval form))))
3134
3135 \f
3136 ;; more complicated compiler macros
3137
3138 (byte-defop-compiler char-before)
3139 (byte-defop-compiler backward-char)
3140 (byte-defop-compiler backward-word)
3141 (byte-defop-compiler list)
3142 (byte-defop-compiler concat)
3143 (byte-defop-compiler fset)
3144 (byte-defop-compiler (indent-to-column byte-indent-to) byte-compile-indent-to)
3145 (byte-defop-compiler indent-to)
3146 (byte-defop-compiler insert)
3147 (byte-defop-compiler-1 function byte-compile-function-form)
3148 (byte-defop-compiler-1 - byte-compile-minus)
3149 (byte-defop-compiler (/ byte-quo) byte-compile-quo)
3150 (byte-defop-compiler nconc)
3151
3152 (defun byte-compile-char-before (form)
3153 (cond ((= 2 (length form))
3154 (byte-compile-form (list 'char-after (if (numberp (nth 1 form))
3155 (1- (nth 1 form))
3156 `(1- ,(nth 1 form))))))
3157 ((= 1 (length form))
3158 (byte-compile-form '(char-after (1- (point)))))
3159 (t (byte-compile-subr-wrong-args form "0-1"))))
3160
3161 ;; backward-... ==> forward-... with negated argument.
3162 (defun byte-compile-backward-char (form)
3163 (cond ((= 2 (length form))
3164 (byte-compile-form (list 'forward-char (if (numberp (nth 1 form))
3165 (- (nth 1 form))
3166 `(- ,(nth 1 form))))))
3167 ((= 1 (length form))
3168 (byte-compile-form '(forward-char -1)))
3169 (t (byte-compile-subr-wrong-args form "0-1"))))
3170
3171 (defun byte-compile-backward-word (form)
3172 (cond ((= 2 (length form))
3173 (byte-compile-form (list 'forward-word (if (numberp (nth 1 form))
3174 (- (nth 1 form))
3175 `(- ,(nth 1 form))))))
3176 ((= 1 (length form))
3177 (byte-compile-form '(forward-word -1)))
3178 (t (byte-compile-subr-wrong-args form "0-1"))))
3179
3180 (defun byte-compile-list (form)
3181 (let ((count (length (cdr form))))
3182 (cond ((= count 0)
3183 (byte-compile-constant nil))
3184 ((< count 5)
3185 (mapc 'byte-compile-form (cdr form))
3186 (byte-compile-out
3187 (aref [byte-list1 byte-list2 byte-list3 byte-list4] (1- count)) 0))
3188 ((< count 256)
3189 (mapc 'byte-compile-form (cdr form))
3190 (byte-compile-out 'byte-listN count))
3191 (t (byte-compile-normal-call form)))))
3192
3193 (defun byte-compile-concat (form)
3194 (let ((count (length (cdr form))))
3195 (cond ((and (< 1 count) (< count 5))
3196 (mapc 'byte-compile-form (cdr form))
3197 (byte-compile-out
3198 (aref [byte-concat2 byte-concat3 byte-concat4] (- count 2))
3199 0))
3200 ;; Concat of one arg is not a no-op if arg is not a string.
3201 ((= count 0)
3202 (byte-compile-form ""))
3203 ((< count 256)
3204 (mapc 'byte-compile-form (cdr form))
3205 (byte-compile-out 'byte-concatN count))
3206 ((byte-compile-normal-call form)))))
3207
3208 (defun byte-compile-minus (form)
3209 (let ((len (length form)))
3210 (cond
3211 ((= 1 len) (byte-compile-constant 0))
3212 ((= 2 len)
3213 (byte-compile-form (cadr form))
3214 (byte-compile-out 'byte-negate 0))
3215 ((= 3 len)
3216 (byte-compile-form (nth 1 form))
3217 (byte-compile-form (nth 2 form))
3218 (byte-compile-out 'byte-diff 0))
3219 ;; Don't use binary operations for > 2 operands, as that may
3220 ;; cause overflow/truncation in float operations.
3221 (t (byte-compile-normal-call form)))))
3222
3223 (defun byte-compile-quo (form)
3224 (let ((len (length form)))
3225 (cond ((<= len 2)
3226 (byte-compile-subr-wrong-args form "2 or more"))
3227 ((= len 3)
3228 (byte-compile-two-args form))
3229 (t
3230 ;; Don't use binary operations for > 2 operands, as that
3231 ;; may cause overflow/truncation in float operations.
3232 (byte-compile-normal-call form)))))
3233
3234 (defun byte-compile-nconc (form)
3235 (let ((len (length form)))
3236 (cond ((= len 1)
3237 (byte-compile-constant nil))
3238 ((= len 2)
3239 ;; nconc of one arg is a noop, even if that arg isn't a list.
3240 (byte-compile-form (nth 1 form)))
3241 (t
3242 (byte-compile-form (car (setq form (cdr form))))
3243 (while (setq form (cdr form))
3244 (byte-compile-form (car form))
3245 (byte-compile-out 'byte-nconc 0))))))
3246
3247 (defun byte-compile-fset (form)
3248 ;; warn about forms like (fset 'foo '(lambda () ...))
3249 ;; (where the lambda expression is non-trivial...)
3250 (let ((fn (nth 2 form))
3251 body)
3252 (if (and (eq (car-safe fn) 'quote)
3253 (eq (car-safe (setq fn (nth 1 fn))) 'lambda))
3254 (progn
3255 (setq body (cdr (cdr fn)))
3256 (if (stringp (car body)) (setq body (cdr body)))
3257 (if (eq 'interactive (car-safe (car body))) (setq body (cdr body)))
3258 (if (and (consp (car body))
3259 (not (eq 'byte-code (car (car body)))))
3260 (byte-compile-warn
3261 "A quoted lambda form is the second argument of `fset'. This is probably
3262 not what you want, as that lambda cannot be compiled. Consider using
3263 the syntax (function (lambda (...) ...)) instead.")))))
3264 (byte-compile-two-args form))
3265
3266 (defun byte-compile-funarg (form)
3267 ;; (mapcar '(lambda (x) ..) ..) ==> (mapcar (function (lambda (x) ..)) ..)
3268 ;; for cases where it's guaranteed that first arg will be used as a lambda.
3269 (byte-compile-normal-call
3270 (let ((fn (nth 1 form)))
3271 (if (and (eq (car-safe fn) 'quote)
3272 (eq (car-safe (nth 1 fn)) 'lambda))
3273 (cons (car form)
3274 (cons (cons 'function (cdr fn))
3275 (cdr (cdr form))))
3276 form))))
3277
3278 (defun byte-compile-funarg-2 (form)
3279 ;; (sort ... '(lambda (x) ..)) ==> (sort ... (function (lambda (x) ..)))
3280 ;; for cases where it's guaranteed that second arg will be used as a lambda.
3281 (byte-compile-normal-call
3282 (let ((fn (nth 2 form)))
3283 (if (and (eq (car-safe fn) 'quote)
3284 (eq (car-safe (nth 1 fn)) 'lambda))
3285 (cons (car form)
3286 (cons (nth 1 form)
3287 (cons (cons 'function (cdr fn))
3288 (cdr (cdr (cdr form))))))
3289 form))))
3290
3291 ;; (function foo) must compile like 'foo, not like (symbol-function 'foo).
3292 ;; Otherwise it will be incompatible with the interpreter,
3293 ;; and (funcall (function foo)) will lose with autoloads.
3294
3295 (defun byte-compile-function-form (form)
3296 (byte-compile-constant
3297 (cond ((symbolp (nth 1 form))
3298 (nth 1 form))
3299 ((byte-compile-lambda (nth 1 form))))))
3300
3301 (defun byte-compile-indent-to (form)
3302 (let ((len (length form)))
3303 (cond ((= len 2)
3304 (byte-compile-form (car (cdr form)))
3305 (byte-compile-out 'byte-indent-to 0))
3306 ((= len 3)
3307 ;; no opcode for 2-arg case.
3308 (byte-compile-normal-call form))
3309 (t
3310 (byte-compile-subr-wrong-args form "1-2")))))
3311
3312 (defun byte-compile-insert (form)
3313 (cond ((null (cdr form))
3314 (byte-compile-constant nil))
3315 ((<= (length form) 256)
3316 (mapc 'byte-compile-form (cdr form))
3317 (if (cdr (cdr form))
3318 (byte-compile-out 'byte-insertN (length (cdr form)))
3319 (byte-compile-out 'byte-insert 0)))
3320 ((memq t (mapcar 'consp (cdr (cdr form))))
3321 (byte-compile-normal-call form))
3322 ;; We can split it; there is no function call after inserting 1st arg.
3323 (t
3324 (while (setq form (cdr form))
3325 (byte-compile-form (car form))
3326 (byte-compile-out 'byte-insert 0)
3327 (if (cdr form)
3328 (byte-compile-discard))))))
3329
3330 \f
3331 (byte-defop-compiler-1 setq)
3332 (byte-defop-compiler-1 setq-default)
3333 (byte-defop-compiler-1 quote)
3334 (byte-defop-compiler-1 quote-form)
3335
3336 (defun byte-compile-setq (form)
3337 (let ((bytecomp-args (cdr form)))
3338 (if bytecomp-args
3339 (while bytecomp-args
3340 (byte-compile-form (car (cdr bytecomp-args)))
3341 (or for-effect (cdr (cdr bytecomp-args))
3342 (byte-compile-out 'byte-dup 0))
3343 (byte-compile-variable-ref 'byte-varset (car bytecomp-args))
3344 (setq bytecomp-args (cdr (cdr bytecomp-args))))
3345 ;; (setq), with no arguments.
3346 (byte-compile-form nil for-effect))
3347 (setq for-effect nil)))
3348
3349 (defun byte-compile-setq-default (form)
3350 (setq form (cdr form))
3351 (if (> (length form) 2)
3352 (let ((setters ()))
3353 (while (consp form)
3354 (push `(setq-default ,(pop form) ,(pop form)) setters))
3355 (byte-compile-form (cons 'progn (nreverse setters))))
3356 (let ((var (car form)))
3357 (and (or (not (symbolp var))
3358 (byte-compile-const-symbol-p var t))
3359 (byte-compile-warning-enabled-p 'constants)
3360 (byte-compile-warn
3361 "variable assignment to %s `%s'"
3362 (if (symbolp var) "constant" "nonvariable")
3363 (prin1-to-string var)))
3364 (byte-compile-normal-call `(set-default ',var ,@(cdr form))))))
3365
3366 (byte-defop-compiler-1 set-default)
3367 (defun byte-compile-set-default (form)
3368 (let ((varexp (car-safe (cdr-safe form))))
3369 (if (eq (car-safe varexp) 'quote)
3370 ;; If the varexp is constant, compile it as a setq-default
3371 ;; so we get more warnings.
3372 (byte-compile-setq-default `(setq-default ,(car-safe (cdr varexp))
3373 ,@(cddr form)))
3374 (byte-compile-normal-call form))))
3375
3376 (defun byte-compile-quote (form)
3377 (byte-compile-constant (car (cdr form))))
3378
3379 (defun byte-compile-quote-form (form)
3380 (byte-compile-constant (byte-compile-top-level (nth 1 form))))
3381
3382 \f
3383 ;;; control structures
3384
3385 (defun byte-compile-body (bytecomp-body &optional for-effect)
3386 (while (cdr bytecomp-body)
3387 (byte-compile-form (car bytecomp-body) t)
3388 (setq bytecomp-body (cdr bytecomp-body)))
3389 (byte-compile-form (car bytecomp-body) for-effect))
3390
3391 (defsubst byte-compile-body-do-effect (bytecomp-body)
3392 (byte-compile-body bytecomp-body for-effect)
3393 (setq for-effect nil))
3394
3395 (defsubst byte-compile-form-do-effect (form)
3396 (byte-compile-form form for-effect)
3397 (setq for-effect nil))
3398
3399 (byte-defop-compiler-1 inline byte-compile-progn)
3400 (byte-defop-compiler-1 progn)
3401 (byte-defop-compiler-1 prog1)
3402 (byte-defop-compiler-1 prog2)
3403 (byte-defop-compiler-1 if)
3404 (byte-defop-compiler-1 cond)
3405 (byte-defop-compiler-1 and)
3406 (byte-defop-compiler-1 or)
3407 (byte-defop-compiler-1 while)
3408 (byte-defop-compiler-1 funcall)
3409 (byte-defop-compiler-1 apply byte-compile-funarg)
3410 (byte-defop-compiler-1 mapcar byte-compile-funarg)
3411 (byte-defop-compiler-1 mapatoms byte-compile-funarg)
3412 (byte-defop-compiler-1 mapconcat byte-compile-funarg)
3413 (byte-defop-compiler-1 mapc byte-compile-funarg)
3414 (byte-defop-compiler-1 maphash byte-compile-funarg)
3415 (byte-defop-compiler-1 map-char-table byte-compile-funarg)
3416 (byte-defop-compiler-1 map-char-table byte-compile-funarg-2)
3417 ;; map-charset-chars should be funarg but has optional third arg
3418 (byte-defop-compiler-1 sort byte-compile-funarg-2)
3419 (byte-defop-compiler-1 let)
3420 (byte-defop-compiler-1 let*)
3421
3422 (defun byte-compile-progn (form)
3423 (byte-compile-body-do-effect (cdr form)))
3424
3425 (defun byte-compile-prog1 (form)
3426 (byte-compile-form-do-effect (car (cdr form)))
3427 (byte-compile-body (cdr (cdr form)) t))
3428
3429 (defun byte-compile-prog2 (form)
3430 (byte-compile-form (nth 1 form) t)
3431 (byte-compile-form-do-effect (nth 2 form))
3432 (byte-compile-body (cdr (cdr (cdr form))) t))
3433
3434 (defmacro byte-compile-goto-if (cond discard tag)
3435 `(byte-compile-goto
3436 (if ,cond
3437 (if ,discard 'byte-goto-if-not-nil 'byte-goto-if-not-nil-else-pop)
3438 (if ,discard 'byte-goto-if-nil 'byte-goto-if-nil-else-pop))
3439 ,tag))
3440
3441 ;; Return the list of items in CONDITION-PARAM that match PRED-LIST.
3442 ;; Only return items that are not in ONLY-IF-NOT-PRESENT.
3443 (defun byte-compile-find-bound-condition (condition-param
3444 pred-list
3445 &optional only-if-not-present)
3446 (let ((result nil)
3447 (nth-one nil)
3448 (cond-list
3449 (if (memq (car-safe condition-param) pred-list)
3450 ;; The condition appears by itself.
3451 (list condition-param)
3452 ;; If the condition is an `and', look for matches among the
3453 ;; `and' arguments.
3454 (when (eq 'and (car-safe condition-param))
3455 (cdr condition-param)))))
3456
3457 (dolist (crt cond-list)
3458 (when (and (memq (car-safe crt) pred-list)
3459 (eq 'quote (car-safe (setq nth-one (nth 1 crt))))
3460 ;; Ignore if the symbol is already on the unresolved
3461 ;; list.
3462 (not (assq (nth 1 nth-one) ; the relevant symbol
3463 only-if-not-present)))
3464 (push (nth 1 (nth 1 crt)) result)))
3465 result))
3466
3467 (defmacro byte-compile-maybe-guarded (condition &rest body)
3468 "Execute forms in BODY, potentially guarded by CONDITION.
3469 CONDITION is a variable whose value is a test in an `if' or `cond'.
3470 BODY is the code to compile in the first arm of the if or the body of
3471 the cond clause. If CONDITION's value is of the form (fboundp 'foo)
3472 or (boundp 'foo), the relevant warnings from BODY about foo's
3473 being undefined (or obsolete) will be suppressed.
3474
3475 If CONDITION's value is (not (featurep 'emacs)) or (featurep 'xemacs),
3476 that suppresses all warnings during execution of BODY."
3477 (declare (indent 1) (debug t))
3478 `(let* ((fbound-list (byte-compile-find-bound-condition
3479 ,condition (list 'fboundp)
3480 byte-compile-unresolved-functions))
3481 (bound-list (byte-compile-find-bound-condition
3482 ,condition (list 'boundp 'default-boundp)))
3483 ;; Maybe add to the bound list.
3484 (byte-compile-bound-variables
3485 (if bound-list
3486 (append bound-list byte-compile-bound-variables)
3487 byte-compile-bound-variables)))
3488 (unwind-protect
3489 ;; If things not being bound at all is ok, so must them being obsolete.
3490 ;; Note that we add to the existing lists since Tramp (ab)uses
3491 ;; this feature.
3492 (let ((byte-compile-not-obsolete-vars
3493 (append byte-compile-not-obsolete-vars bound-list))
3494 (byte-compile-not-obsolete-funcs
3495 (append byte-compile-not-obsolete-funcs fbound-list)))
3496 ,@body)
3497 ;; Maybe remove the function symbol from the unresolved list.
3498 (dolist (fbound fbound-list)
3499 (when fbound
3500 (setq byte-compile-unresolved-functions
3501 (delq (assq fbound byte-compile-unresolved-functions)
3502 byte-compile-unresolved-functions)))))))
3503
3504 (defun byte-compile-if (form)
3505 (byte-compile-form (car (cdr form)))
3506 ;; Check whether we have `(if (fboundp ...' or `(if (boundp ...'
3507 ;; and avoid warnings about the relevent symbols in the consequent.
3508 (let ((clause (nth 1 form))
3509 (donetag (byte-compile-make-tag)))
3510 (if (null (nthcdr 3 form))
3511 ;; No else-forms
3512 (progn
3513 (byte-compile-goto-if nil for-effect donetag)
3514 (byte-compile-maybe-guarded clause
3515 (byte-compile-form (nth 2 form) for-effect))
3516 (byte-compile-out-tag donetag))
3517 (let ((elsetag (byte-compile-make-tag)))
3518 (byte-compile-goto 'byte-goto-if-nil elsetag)
3519 (byte-compile-maybe-guarded clause
3520 (byte-compile-form (nth 2 form) for-effect))
3521 (byte-compile-goto 'byte-goto donetag)
3522 (byte-compile-out-tag elsetag)
3523 (byte-compile-maybe-guarded (list 'not clause)
3524 (byte-compile-body (cdr (cdr (cdr form))) for-effect))
3525 (byte-compile-out-tag donetag))))
3526 (setq for-effect nil))
3527
3528 (defun byte-compile-cond (clauses)
3529 (let ((donetag (byte-compile-make-tag))
3530 nexttag clause)
3531 (while (setq clauses (cdr clauses))
3532 (setq clause (car clauses))
3533 (cond ((or (eq (car clause) t)
3534 (and (eq (car-safe (car clause)) 'quote)
3535 (car-safe (cdr-safe (car clause)))))
3536 ;; Unconditional clause
3537 (setq clause (cons t clause)
3538 clauses nil))
3539 ((cdr clauses)
3540 (byte-compile-form (car clause))
3541 (if (null (cdr clause))
3542 ;; First clause is a singleton.
3543 (byte-compile-goto-if t for-effect donetag)
3544 (setq nexttag (byte-compile-make-tag))
3545 (byte-compile-goto 'byte-goto-if-nil nexttag)
3546 (byte-compile-maybe-guarded (car clause)
3547 (byte-compile-body (cdr clause) for-effect))
3548 (byte-compile-goto 'byte-goto donetag)
3549 (byte-compile-out-tag nexttag)))))
3550 ;; Last clause
3551 (let ((guard (car clause)))
3552 (and (cdr clause) (not (eq guard t))
3553 (progn (byte-compile-form guard)
3554 (byte-compile-goto-if nil for-effect donetag)
3555 (setq clause (cdr clause))))
3556 (byte-compile-maybe-guarded guard
3557 (byte-compile-body-do-effect clause)))
3558 (byte-compile-out-tag donetag)))
3559
3560 (defun byte-compile-and (form)
3561 (let ((failtag (byte-compile-make-tag))
3562 (bytecomp-args (cdr form)))
3563 (if (null bytecomp-args)
3564 (byte-compile-form-do-effect t)
3565 (byte-compile-and-recursion bytecomp-args failtag))))
3566
3567 ;; Handle compilation of a nontrivial `and' call.
3568 ;; We use tail recursion so we can use byte-compile-maybe-guarded.
3569 (defun byte-compile-and-recursion (rest failtag)
3570 (if (cdr rest)
3571 (progn
3572 (byte-compile-form (car rest))
3573 (byte-compile-goto-if nil for-effect failtag)
3574 (byte-compile-maybe-guarded (car rest)
3575 (byte-compile-and-recursion (cdr rest) failtag)))
3576 (byte-compile-form-do-effect (car rest))
3577 (byte-compile-out-tag failtag)))
3578
3579 (defun byte-compile-or (form)
3580 (let ((wintag (byte-compile-make-tag))
3581 (bytecomp-args (cdr form)))
3582 (if (null bytecomp-args)
3583 (byte-compile-form-do-effect nil)
3584 (byte-compile-or-recursion bytecomp-args wintag))))
3585
3586 ;; Handle compilation of a nontrivial `or' call.
3587 ;; We use tail recursion so we can use byte-compile-maybe-guarded.
3588 (defun byte-compile-or-recursion (rest wintag)
3589 (if (cdr rest)
3590 (progn
3591 (byte-compile-form (car rest))
3592 (byte-compile-goto-if t for-effect wintag)
3593 (byte-compile-maybe-guarded (list 'not (car rest))
3594 (byte-compile-or-recursion (cdr rest) wintag)))
3595 (byte-compile-form-do-effect (car rest))
3596 (byte-compile-out-tag wintag)))
3597
3598 (defun byte-compile-while (form)
3599 (let ((endtag (byte-compile-make-tag))
3600 (looptag (byte-compile-make-tag)))
3601 (byte-compile-out-tag looptag)
3602 (byte-compile-form (car (cdr form)))
3603 (byte-compile-goto-if nil for-effect endtag)
3604 (byte-compile-body (cdr (cdr form)) t)
3605 (byte-compile-goto 'byte-goto looptag)
3606 (byte-compile-out-tag endtag)
3607 (setq for-effect nil)))
3608
3609 (defun byte-compile-funcall (form)
3610 (mapc 'byte-compile-form (cdr form))
3611 (byte-compile-out 'byte-call (length (cdr (cdr form)))))
3612
3613
3614 (defun byte-compile-let (form)
3615 ;; First compute the binding values in the old scope.
3616 (let ((varlist (car (cdr form))))
3617 (dolist (var varlist)
3618 (if (consp var)
3619 (byte-compile-form (car (cdr var)))
3620 (byte-compile-push-constant nil))))
3621 (let ((byte-compile-bound-variables byte-compile-bound-variables) ;new scope
3622 (varlist (reverse (car (cdr form)))))
3623 (dolist (var varlist)
3624 (byte-compile-variable-ref 'byte-varbind
3625 (if (consp var) (car var) var)))
3626 (byte-compile-body-do-effect (cdr (cdr form)))
3627 (byte-compile-out 'byte-unbind (length (car (cdr form))))))
3628
3629 (defun byte-compile-let* (form)
3630 (let ((byte-compile-bound-variables byte-compile-bound-variables) ;new scope
3631 (varlist (copy-sequence (car (cdr form)))))
3632 (dolist (var varlist)
3633 (if (atom var)
3634 (byte-compile-push-constant nil)
3635 (byte-compile-form (car (cdr var)))
3636 (setq var (car var)))
3637 (byte-compile-variable-ref 'byte-varbind var))
3638 (byte-compile-body-do-effect (cdr (cdr form)))
3639 (byte-compile-out 'byte-unbind (length (car (cdr form))))))
3640
3641
3642 (byte-defop-compiler-1 /= byte-compile-negated)
3643 (byte-defop-compiler-1 atom byte-compile-negated)
3644 (byte-defop-compiler-1 nlistp byte-compile-negated)
3645
3646 (put '/= 'byte-compile-negated-op '=)
3647 (put 'atom 'byte-compile-negated-op 'consp)
3648 (put 'nlistp 'byte-compile-negated-op 'listp)
3649
3650 (defun byte-compile-negated (form)
3651 (byte-compile-form-do-effect (byte-compile-negation-optimizer form)))
3652
3653 ;; Even when optimization is off, /= is optimized to (not (= ...)).
3654 (defun byte-compile-negation-optimizer (form)
3655 ;; an optimizer for forms where <form1> is less efficient than (not <form2>)
3656 (byte-compile-set-symbol-position (car form))
3657 (list 'not
3658 (cons (or (get (car form) 'byte-compile-negated-op)
3659 (error
3660 "Compiler error: `%s' has no `byte-compile-negated-op' property"
3661 (car form)))
3662 (cdr form))))
3663 \f
3664 ;;; other tricky macro-like special-forms
3665
3666 (byte-defop-compiler-1 catch)
3667 (byte-defop-compiler-1 unwind-protect)
3668 (byte-defop-compiler-1 condition-case)
3669 (byte-defop-compiler-1 save-excursion)
3670 (byte-defop-compiler-1 save-current-buffer)
3671 (byte-defop-compiler-1 save-restriction)
3672 (byte-defop-compiler-1 save-window-excursion)
3673 (byte-defop-compiler-1 with-output-to-temp-buffer)
3674 (byte-defop-compiler-1 track-mouse)
3675
3676 (defun byte-compile-catch (form)
3677 (byte-compile-form (car (cdr form)))
3678 (byte-compile-push-constant
3679 (byte-compile-top-level (cons 'progn (cdr (cdr form))) for-effect))
3680 (byte-compile-out 'byte-catch 0))
3681
3682 (defun byte-compile-unwind-protect (form)
3683 (byte-compile-push-constant
3684 (byte-compile-top-level-body (cdr (cdr form)) t))
3685 (byte-compile-out 'byte-unwind-protect 0)
3686 (byte-compile-form-do-effect (car (cdr form)))
3687 (byte-compile-out 'byte-unbind 1))
3688
3689 (defun byte-compile-track-mouse (form)
3690 (byte-compile-form
3691 `(funcall '(lambda nil
3692 (track-mouse ,@(byte-compile-top-level-body (cdr form)))))))
3693
3694 (defun byte-compile-condition-case (form)
3695 (let* ((var (nth 1 form))
3696 (byte-compile-bound-variables
3697 (if var (cons var byte-compile-bound-variables)
3698 byte-compile-bound-variables)))
3699 (byte-compile-set-symbol-position 'condition-case)
3700 (unless (symbolp var)
3701 (byte-compile-warn
3702 "`%s' is not a variable-name or nil (in condition-case)" var))
3703 (byte-compile-push-constant var)
3704 (byte-compile-push-constant (byte-compile-top-level
3705 (nth 2 form) for-effect))
3706 (let ((clauses (cdr (cdr (cdr form))))
3707 compiled-clauses)
3708 (while clauses
3709 (let* ((clause (car clauses))
3710 (condition (car clause)))
3711 (cond ((not (or (symbolp condition)
3712 (and (listp condition)
3713 (let ((syms condition) (ok t))
3714 (while syms
3715 (if (not (symbolp (car syms)))
3716 (setq ok nil))
3717 (setq syms (cdr syms)))
3718 ok))))
3719 (byte-compile-warn
3720 "`%s' is not a condition name or list of such (in condition-case)"
3721 (prin1-to-string condition)))
3722 ;; ((not (or (eq condition 't)
3723 ;; (and (stringp (get condition 'error-message))
3724 ;; (consp (get condition 'error-conditions)))))
3725 ;; (byte-compile-warn
3726 ;; "`%s' is not a known condition name (in condition-case)"
3727 ;; condition))
3728 )
3729 (setq compiled-clauses
3730 (cons (cons condition
3731 (byte-compile-top-level-body
3732 (cdr clause) for-effect))
3733 compiled-clauses)))
3734 (setq clauses (cdr clauses)))
3735 (byte-compile-push-constant (nreverse compiled-clauses)))
3736 (byte-compile-out 'byte-condition-case 0)))
3737
3738
3739 (defun byte-compile-save-excursion (form)
3740 (if (and (eq 'set-buffer (car-safe (car-safe (cdr form))))
3741 (byte-compile-warning-enabled-p 'suspicious))
3742 (byte-compile-warn "`save-excursion' defeated by `set-buffer'"))
3743 (byte-compile-out 'byte-save-excursion 0)
3744 (byte-compile-body-do-effect (cdr form))
3745 (byte-compile-out 'byte-unbind 1))
3746
3747 (defun byte-compile-save-restriction (form)
3748 (byte-compile-out 'byte-save-restriction 0)
3749 (byte-compile-body-do-effect (cdr form))
3750 (byte-compile-out 'byte-unbind 1))
3751
3752 (defun byte-compile-save-current-buffer (form)
3753 (byte-compile-out 'byte-save-current-buffer 0)
3754 (byte-compile-body-do-effect (cdr form))
3755 (byte-compile-out 'byte-unbind 1))
3756
3757 (defun byte-compile-save-window-excursion (form)
3758 (byte-compile-push-constant
3759 (byte-compile-top-level-body (cdr form) for-effect))
3760 (byte-compile-out 'byte-save-window-excursion 0))
3761
3762 (defun byte-compile-with-output-to-temp-buffer (form)
3763 (byte-compile-form (car (cdr form)))
3764 (byte-compile-out 'byte-temp-output-buffer-setup 0)
3765 (byte-compile-body (cdr (cdr form)))
3766 (byte-compile-out 'byte-temp-output-buffer-show 0))
3767 \f
3768 ;;; top-level forms elsewhere
3769
3770 (byte-defop-compiler-1 defun)
3771 (byte-defop-compiler-1 defmacro)
3772 (byte-defop-compiler-1 defvar)
3773 (byte-defop-compiler-1 defconst byte-compile-defvar)
3774 (byte-defop-compiler-1 autoload)
3775 (byte-defop-compiler-1 lambda byte-compile-lambda-form)
3776
3777 (defun byte-compile-defun (form)
3778 ;; This is not used for file-level defuns with doc strings.
3779 (if (symbolp (car form))
3780 (byte-compile-set-symbol-position (car form))
3781 (byte-compile-set-symbol-position 'defun)
3782 (error "defun name must be a symbol, not %s" (car form)))
3783 ;; We prefer to generate a defalias form so it will record the function
3784 ;; definition just like interpreting a defun.
3785 (byte-compile-form
3786 (list 'defalias
3787 (list 'quote (nth 1 form))
3788 (byte-compile-byte-code-maker
3789 (byte-compile-lambda (cdr (cdr form)) t)))
3790 t)
3791 (byte-compile-constant (nth 1 form)))
3792
3793 (defun byte-compile-defmacro (form)
3794 ;; This is not used for file-level defmacros with doc strings.
3795 (byte-compile-body-do-effect
3796 (let ((decls (byte-compile-defmacro-declaration form))
3797 (code (byte-compile-byte-code-maker
3798 (byte-compile-lambda (cdr (cdr form)) t))))
3799 `((defalias ',(nth 1 form)
3800 ,(if (eq (car-safe code) 'make-byte-code)
3801 `(cons 'macro ,code)
3802 `'(macro . ,(eval code))))
3803 ,@decls
3804 ',(nth 1 form)))))
3805
3806 (defun byte-compile-defvar (form)
3807 ;; This is not used for file-level defvar/consts with doc strings.
3808 (when (and (symbolp (nth 1 form))
3809 (not (string-match "[-*/:$]" (symbol-name (nth 1 form))))
3810 (byte-compile-warning-enabled-p 'lexical))
3811 (byte-compile-warn "global/dynamic var `%s' lacks a prefix"
3812 (nth 1 form)))
3813 (let ((fun (nth 0 form))
3814 (var (nth 1 form))
3815 (value (nth 2 form))
3816 (string (nth 3 form)))
3817 (byte-compile-set-symbol-position fun)
3818 (when (or (> (length form) 4)
3819 (and (eq fun 'defconst) (null (cddr form))))
3820 (let ((ncall (length (cdr form))))
3821 (byte-compile-warn
3822 "`%s' called with %d argument%s, but %s %s"
3823 fun ncall
3824 (if (= 1 ncall) "" "s")
3825 (if (< ncall 2) "requires" "accepts only")
3826 "2-3")))
3827 (push var byte-compile-bound-variables)
3828 (if (eq fun 'defconst)
3829 (push var byte-compile-const-variables))
3830 (byte-compile-body-do-effect
3831 (list
3832 ;; Put the defined variable in this library's load-history entry
3833 ;; just as a real defvar would, but only in top-level forms.
3834 (when (and (cddr form) (null byte-compile-current-form))
3835 `(push ',var current-load-list))
3836 (when (> (length form) 3)
3837 (when (and string (not (stringp string)))
3838 (byte-compile-warn "third arg to `%s %s' is not a string: %s"
3839 fun var string))
3840 `(put ',var 'variable-documentation ,string))
3841 (if (cddr form) ; `value' provided
3842 (let ((byte-compile-not-obsolete-vars (list var)))
3843 (if (eq fun 'defconst)
3844 ;; `defconst' sets `var' unconditionally.
3845 (let ((tmp (make-symbol "defconst-tmp-var")))
3846 `(funcall '(lambda (,tmp) (defconst ,var ,tmp))
3847 ,value))
3848 ;; `defvar' sets `var' only when unbound.
3849 `(if (not (default-boundp ',var)) (setq-default ,var ,value))))
3850 (when (eq fun 'defconst)
3851 ;; This will signal an appropriate error at runtime.
3852 `(eval ',form)))
3853 `',var))))
3854
3855 (defun byte-compile-autoload (form)
3856 (byte-compile-set-symbol-position 'autoload)
3857 (and (byte-compile-constp (nth 1 form))
3858 (byte-compile-constp (nth 5 form))
3859 (eval (nth 5 form)) ; macro-p
3860 (not (fboundp (eval (nth 1 form))))
3861 (byte-compile-warn
3862 "The compiler ignores `autoload' except at top level. You should
3863 probably put the autoload of the macro `%s' at top-level."
3864 (eval (nth 1 form))))
3865 (byte-compile-normal-call form))
3866
3867 ;; Lambdas in valid places are handled as special cases by various code.
3868 ;; The ones that remain are errors.
3869 (defun byte-compile-lambda-form (form)
3870 (byte-compile-set-symbol-position 'lambda)
3871 (error "`lambda' used as function name is invalid"))
3872
3873 ;; Compile normally, but deal with warnings for the function being defined.
3874 (put 'defalias 'byte-hunk-handler 'byte-compile-file-form-defalias)
3875 (defun byte-compile-file-form-defalias (form)
3876 (if (and (consp (cdr form)) (consp (nth 1 form))
3877 (eq (car (nth 1 form)) 'quote)
3878 (consp (cdr (nth 1 form)))
3879 (symbolp (nth 1 (nth 1 form))))
3880 (let ((constant
3881 (and (consp (nthcdr 2 form))
3882 (consp (nth 2 form))
3883 (eq (car (nth 2 form)) 'quote)
3884 (consp (cdr (nth 2 form)))
3885 (symbolp (nth 1 (nth 2 form))))))
3886 (byte-compile-defalias-warn (nth 1 (nth 1 form)))
3887 (push (cons (nth 1 (nth 1 form))
3888 (if constant (nth 1 (nth 2 form)) t))
3889 byte-compile-function-environment)))
3890 ;; We used to just do: (byte-compile-normal-call form)
3891 ;; But it turns out that this fails to optimize the code.
3892 ;; So instead we now do the same as what other byte-hunk-handlers do,
3893 ;; which is to call back byte-compile-file-form and then return nil.
3894 ;; Except that we can't just call byte-compile-file-form since it would
3895 ;; call us right back.
3896 (byte-compile-keep-pending form)
3897 ;; Return nil so the form is not output twice.
3898 nil)
3899
3900 ;; Turn off warnings about prior calls to the function being defalias'd.
3901 ;; This could be smarter and compare those calls with
3902 ;; the function it is being aliased to.
3903 (defun byte-compile-defalias-warn (new)
3904 (let ((calls (assq new byte-compile-unresolved-functions)))
3905 (if calls
3906 (setq byte-compile-unresolved-functions
3907 (delq calls byte-compile-unresolved-functions)))))
3908
3909 (byte-defop-compiler-1 with-no-warnings byte-compile-no-warnings)
3910 (defun byte-compile-no-warnings (form)
3911 (let (byte-compile-warnings)
3912 (byte-compile-form (cons 'progn (cdr form)))))
3913
3914 ;; Warn about misuses of make-variable-buffer-local.
3915 (byte-defop-compiler-1 make-variable-buffer-local
3916 byte-compile-make-variable-buffer-local)
3917 (defun byte-compile-make-variable-buffer-local (form)
3918 (if (and (eq (car-safe (car-safe (cdr-safe form))) 'quote)
3919 (byte-compile-warning-enabled-p 'make-local))
3920 (byte-compile-warn
3921 "`make-variable-buffer-local' should be called at toplevel"))
3922 (byte-compile-normal-call form))
3923 (put 'make-variable-buffer-local
3924 'byte-hunk-handler 'byte-compile-form-make-variable-buffer-local)
3925 (defun byte-compile-form-make-variable-buffer-local (form)
3926 (byte-compile-keep-pending form 'byte-compile-normal-call))
3927
3928 \f
3929 ;;; tags
3930
3931 ;; Note: Most operations will strip off the 'TAG, but it speeds up
3932 ;; optimization to have the 'TAG as a part of the tag.
3933 ;; Tags will be (TAG . (tag-number . stack-depth)).
3934 (defun byte-compile-make-tag ()
3935 (list 'TAG (setq byte-compile-tag-number (1+ byte-compile-tag-number))))
3936
3937
3938 (defun byte-compile-out-tag (tag)
3939 (setq byte-compile-output (cons tag byte-compile-output))
3940 (if (cdr (cdr tag))
3941 (progn
3942 ;; ## remove this someday
3943 (and byte-compile-depth
3944 (not (= (cdr (cdr tag)) byte-compile-depth))
3945 (error "Compiler bug: depth conflict at tag %d" (car (cdr tag))))
3946 (setq byte-compile-depth (cdr (cdr tag))))
3947 (setcdr (cdr tag) byte-compile-depth)))
3948
3949 (defun byte-compile-goto (opcode tag)
3950 (push (cons opcode tag) byte-compile-output)
3951 (setcdr (cdr tag) (if (memq opcode byte-goto-always-pop-ops)
3952 (1- byte-compile-depth)
3953 byte-compile-depth))
3954 (setq byte-compile-depth (and (not (eq opcode 'byte-goto))
3955 (1- byte-compile-depth))))
3956
3957 (defun byte-compile-out (opcode offset)
3958 (push (cons opcode offset) byte-compile-output)
3959 (cond ((eq opcode 'byte-call)
3960 (setq byte-compile-depth (- byte-compile-depth offset)))
3961 ((eq opcode 'byte-return)
3962 ;; This is actually an unnecessary case, because there should be
3963 ;; no more opcodes behind byte-return.
3964 (setq byte-compile-depth nil))
3965 (t
3966 (setq byte-compile-depth (+ byte-compile-depth
3967 (or (aref byte-stack+-info
3968 (symbol-value opcode))
3969 (- (1- offset))))
3970 byte-compile-maxdepth (max byte-compile-depth
3971 byte-compile-maxdepth))))
3972 ;;(if (< byte-compile-depth 0) (error "Compiler error: stack underflow"))
3973 )
3974
3975 \f
3976 ;;; call tree stuff
3977
3978 (defun byte-compile-annotate-call-tree (form)
3979 (let (entry)
3980 ;; annotate the current call
3981 (if (setq entry (assq (car form) byte-compile-call-tree))
3982 (or (memq byte-compile-current-form (nth 1 entry)) ;callers
3983 (setcar (cdr entry)
3984 (cons byte-compile-current-form (nth 1 entry))))
3985 (setq byte-compile-call-tree
3986 (cons (list (car form) (list byte-compile-current-form) nil)
3987 byte-compile-call-tree)))
3988 ;; annotate the current function
3989 (if (setq entry (assq byte-compile-current-form byte-compile-call-tree))
3990 (or (memq (car form) (nth 2 entry)) ;called
3991 (setcar (cdr (cdr entry))
3992 (cons (car form) (nth 2 entry))))
3993 (setq byte-compile-call-tree
3994 (cons (list byte-compile-current-form nil (list (car form)))
3995 byte-compile-call-tree)))
3996 ))
3997
3998 ;; Renamed from byte-compile-report-call-tree
3999 ;; to avoid interfering with completion of byte-compile-file.
4000 ;;;###autoload
4001 (defun display-call-tree (&optional filename)
4002 "Display a call graph of a specified file.
4003 This lists which functions have been called, what functions called
4004 them, and what functions they call. The list includes all functions
4005 whose definitions have been compiled in this Emacs session, as well as
4006 all functions called by those functions.
4007
4008 The call graph does not include macros, inline functions, or
4009 primitives that the byte-code interpreter knows about directly \(eq,
4010 cons, etc.\).
4011
4012 The call tree also lists those functions which are not known to be called
4013 \(that is, to which no calls have been compiled\), and which cannot be
4014 invoked interactively."
4015 (interactive)
4016 (message "Generating call tree...")
4017 (with-output-to-temp-buffer "*Call-Tree*"
4018 (set-buffer "*Call-Tree*")
4019 (erase-buffer)
4020 (message "Generating call tree... (sorting on %s)"
4021 byte-compile-call-tree-sort)
4022 (insert "Call tree for "
4023 (cond ((null byte-compile-current-file) (or filename "???"))
4024 ((stringp byte-compile-current-file)
4025 byte-compile-current-file)
4026 (t (buffer-name byte-compile-current-file)))
4027 " sorted on "
4028 (prin1-to-string byte-compile-call-tree-sort)
4029 ":\n\n")
4030 (if byte-compile-call-tree-sort
4031 (setq byte-compile-call-tree
4032 (sort byte-compile-call-tree
4033 (cond ((eq byte-compile-call-tree-sort 'callers)
4034 (function (lambda (x y) (< (length (nth 1 x))
4035 (length (nth 1 y))))))
4036 ((eq byte-compile-call-tree-sort 'calls)
4037 (function (lambda (x y) (< (length (nth 2 x))
4038 (length (nth 2 y))))))
4039 ((eq byte-compile-call-tree-sort 'calls+callers)
4040 (function (lambda (x y) (< (+ (length (nth 1 x))
4041 (length (nth 2 x)))
4042 (+ (length (nth 1 y))
4043 (length (nth 2 y)))))))
4044 ((eq byte-compile-call-tree-sort 'name)
4045 (function (lambda (x y) (string< (car x)
4046 (car y)))))
4047 (t (error "`byte-compile-call-tree-sort': `%s' - unknown sort mode"
4048 byte-compile-call-tree-sort))))))
4049 (message "Generating call tree...")
4050 (let ((rest byte-compile-call-tree)
4051 (b (current-buffer))
4052 f p
4053 callers calls)
4054 (while rest
4055 (prin1 (car (car rest)) b)
4056 (setq callers (nth 1 (car rest))
4057 calls (nth 2 (car rest)))
4058 (insert "\t"
4059 (cond ((not (fboundp (setq f (car (car rest)))))
4060 (if (null f)
4061 " <top level>";; shouldn't insert nil then, actually -sk
4062 " <not defined>"))
4063 ((subrp (setq f (symbol-function f)))
4064 " <subr>")
4065 ((symbolp f)
4066 (format " ==> %s" f))
4067 ((byte-code-function-p f)
4068 "<compiled function>")
4069 ((not (consp f))
4070 "<malformed function>")
4071 ((eq 'macro (car f))
4072 (if (or (byte-code-function-p (cdr f))
4073 (assq 'byte-code (cdr (cdr (cdr f)))))
4074 " <compiled macro>"
4075 " <macro>"))
4076 ((assq 'byte-code (cdr (cdr f)))
4077 "<compiled lambda>")
4078 ((eq 'lambda (car f))
4079 "<function>")
4080 (t "???"))
4081 (format " (%d callers + %d calls = %d)"
4082 ;; Does the optimizer eliminate common subexpressions?-sk
4083 (length callers)
4084 (length calls)
4085 (+ (length callers) (length calls)))
4086 "\n")
4087 (if callers
4088 (progn
4089 (insert " called by:\n")
4090 (setq p (point))
4091 (insert " " (if (car callers)
4092 (mapconcat 'symbol-name callers ", ")
4093 "<top level>"))
4094 (let ((fill-prefix " "))
4095 (fill-region-as-paragraph p (point)))
4096 (unless (= 0 (current-column))
4097 (insert "\n"))))
4098 (if calls
4099 (progn
4100 (insert " calls:\n")
4101 (setq p (point))
4102 (insert " " (mapconcat 'symbol-name calls ", "))
4103 (let ((fill-prefix " "))
4104 (fill-region-as-paragraph p (point)))
4105 (unless (= 0 (current-column))
4106 (insert "\n"))))
4107 (setq rest (cdr rest)))
4108
4109 (message "Generating call tree...(finding uncalled functions...)")
4110 (setq rest byte-compile-call-tree)
4111 (let (uncalled def)
4112 (while rest
4113 (or (nth 1 (car rest))
4114 (null (setq f (caar rest)))
4115 (progn
4116 (setq def (byte-compile-fdefinition f t))
4117 (and (eq (car-safe def) 'macro)
4118 (eq (car-safe (cdr-safe def)) 'lambda)
4119 (setq def (cdr def)))
4120 (functionp def))
4121 (progn
4122 (setq def (byte-compile-fdefinition f nil))
4123 (and (eq (car-safe def) 'macro)
4124 (eq (car-safe (cdr-safe def)) 'lambda)
4125 (setq def (cdr def)))
4126 (commandp def))
4127 (setq uncalled (cons f uncalled)))
4128 (setq rest (cdr rest)))
4129 (if uncalled
4130 (let ((fill-prefix " "))
4131 (insert "Noninteractive functions not known to be called:\n ")
4132 (setq p (point))
4133 (insert (mapconcat 'symbol-name (nreverse uncalled) ", "))
4134 (fill-region-as-paragraph p (point))))))
4135 (message "Generating call tree...done.")))
4136
4137 \f
4138 ;;;###autoload
4139 (defun batch-byte-compile-if-not-done ()
4140 "Like `byte-compile-file' but doesn't recompile if already up to date.
4141 Use this from the command line, with `-batch';
4142 it won't work in an interactive Emacs."
4143 (batch-byte-compile t))
4144
4145 ;;; by crl@newton.purdue.edu
4146 ;;; Only works noninteractively.
4147 ;;;###autoload
4148 (defun batch-byte-compile (&optional noforce)
4149 "Run `byte-compile-file' on the files remaining on the command line.
4150 Use this from the command line, with `-batch';
4151 it won't work in an interactive Emacs.
4152 Each file is processed even if an error occurred previously.
4153 For example, invoke \"emacs -batch -f batch-byte-compile $emacs/ ~/*.el\".
4154 If NOFORCE is non-nil, don't recompile a file that seems to be
4155 already up-to-date."
4156 ;; command-line-args-left is what is left of the command line (from startup.el)
4157 (defvar command-line-args-left) ;Avoid 'free variable' warning
4158 (if (not noninteractive)
4159 (error "`batch-byte-compile' is to be used only with -batch"))
4160 (let ((bytecomp-error nil))
4161 (while command-line-args-left
4162 (if (file-directory-p (expand-file-name (car command-line-args-left)))
4163 ;; Directory as argument.
4164 (let ((bytecomp-files (directory-files (car command-line-args-left)))
4165 bytecomp-source bytecomp-dest)
4166 (dolist (bytecomp-file bytecomp-files)
4167 (if (and (string-match emacs-lisp-file-regexp bytecomp-file)
4168 (not (auto-save-file-name-p bytecomp-file))
4169 (setq bytecomp-source
4170 (expand-file-name bytecomp-file
4171 (car command-line-args-left)))
4172 (setq bytecomp-dest (byte-compile-dest-file
4173 bytecomp-source))
4174 (file-exists-p bytecomp-dest)
4175 (file-newer-than-file-p bytecomp-source bytecomp-dest))
4176 (if (null (batch-byte-compile-file bytecomp-source))
4177 (setq bytecomp-error t)))))
4178 ;; Specific file argument
4179 (if (or (not noforce)
4180 (let* ((bytecomp-source (car command-line-args-left))
4181 (bytecomp-dest (byte-compile-dest-file bytecomp-source)))
4182 (or (not (file-exists-p bytecomp-dest))
4183 (file-newer-than-file-p bytecomp-source bytecomp-dest))))
4184 (if (null (batch-byte-compile-file (car command-line-args-left)))
4185 (setq bytecomp-error t))))
4186 (setq command-line-args-left (cdr command-line-args-left)))
4187 (kill-emacs (if bytecomp-error 1 0))))
4188
4189 (defun batch-byte-compile-file (bytecomp-file)
4190 (if debug-on-error
4191 (byte-compile-file bytecomp-file)
4192 (condition-case err
4193 (byte-compile-file bytecomp-file)
4194 (file-error
4195 (message (if (cdr err)
4196 ">>Error occurred processing %s: %s (%s)"
4197 ">>Error occurred processing %s: %s")
4198 bytecomp-file
4199 (get (car err) 'error-message)
4200 (prin1-to-string (cdr err)))
4201 (let ((bytecomp-destfile (byte-compile-dest-file bytecomp-file)))
4202 (if (file-exists-p bytecomp-destfile)
4203 (delete-file bytecomp-destfile)))
4204 nil)
4205 (error
4206 (message (if (cdr err)
4207 ">>Error occurred processing %s: %s (%s)"
4208 ">>Error occurred processing %s: %s")
4209 bytecomp-file
4210 (get (car err) 'error-message)
4211 (prin1-to-string (cdr err)))
4212 nil))))
4213
4214 (defun byte-compile-refresh-preloaded ()
4215 "Reload any Lisp file that was changed since Emacs was dumped.
4216 Use with caution."
4217 (let* ((argv0 (car command-line-args))
4218 (emacs-file (executable-find argv0)))
4219 (if (not (and emacs-file (file-executable-p emacs-file)))
4220 (message "Can't find %s to refresh preloaded Lisp files" argv0)
4221 (dolist (f (reverse load-history))
4222 (setq f (car f))
4223 (if (string-match "elc\\'" f) (setq f (substring f 0 -1)))
4224 (when (and (file-readable-p f)
4225 (file-newer-than-file-p f emacs-file))
4226 (message "Reloading stale %s" (file-name-nondirectory f))
4227 (condition-case nil
4228 (load f 'noerror nil 'nosuffix)
4229 ;; Probably shouldn't happen, but in case of an error, it seems
4230 ;; at least as useful to ignore it as it is to stop compilation.
4231 (error nil)))))))
4232
4233 ;;;###autoload
4234 (defun batch-byte-recompile-directory (&optional arg)
4235 "Run `byte-recompile-directory' on the dirs remaining on the command line.
4236 Must be used only with `-batch', and kills Emacs on completion.
4237 For example, invoke `emacs -batch -f batch-byte-recompile-directory .'.
4238
4239 Optional argument ARG is passed as second argument ARG to
4240 `byte-recompile-directory'; see there for its possible values
4241 and corresponding effects."
4242 ;; command-line-args-left is what is left of the command line (startup.el)
4243 (defvar command-line-args-left) ;Avoid 'free variable' warning
4244 (if (not noninteractive)
4245 (error "batch-byte-recompile-directory is to be used only with -batch"))
4246 (or command-line-args-left
4247 (setq command-line-args-left '(".")))
4248 (while command-line-args-left
4249 (byte-recompile-directory (car command-line-args-left) arg)
4250 (setq command-line-args-left (cdr command-line-args-left)))
4251 (kill-emacs 0))
4252
4253 (provide 'byte-compile)
4254 (provide 'bytecomp)
4255
4256 \f
4257 ;;; report metering (see the hacks in bytecode.c)
4258
4259 (defvar byte-code-meter)
4260 (defun byte-compile-report-ops ()
4261 (or (boundp 'byte-metering-on)
4262 (error "You must build Emacs with -DBYTE_CODE_METER to use this"))
4263 (with-output-to-temp-buffer "*Meter*"
4264 (set-buffer "*Meter*")
4265 (let ((i 0) n op off)
4266 (while (< i 256)
4267 (setq n (aref (aref byte-code-meter 0) i)
4268 off nil)
4269 (if t ;(not (zerop n))
4270 (progn
4271 (setq op i)
4272 (setq off nil)
4273 (cond ((< op byte-nth)
4274 (setq off (logand op 7))
4275 (setq op (logand op 248)))
4276 ((>= op byte-constant)
4277 (setq off (- op byte-constant)
4278 op byte-constant)))
4279 (setq op (aref byte-code-vector op))
4280 (insert (format "%-4d" i))
4281 (insert (symbol-name op))
4282 (if off (insert " [" (int-to-string off) "]"))
4283 (indent-to 40)
4284 (insert (int-to-string n) "\n")))
4285 (setq i (1+ i))))))
4286 \f
4287 ;; To avoid "lisp nesting exceeds max-lisp-eval-depth" when bytecomp compiles
4288 ;; itself, compile some of its most used recursive functions (at load time).
4289 ;;
4290 (eval-when-compile
4291 (or (byte-code-function-p (symbol-function 'byte-compile-form))
4292 (assq 'byte-code (symbol-function 'byte-compile-form))
4293 (let ((byte-optimize nil) ; do it fast
4294 (byte-compile-warnings nil))
4295 (mapc (lambda (x)
4296 (or noninteractive (message "compiling %s..." x))
4297 (byte-compile x)
4298 (or noninteractive (message "compiling %s...done" x)))
4299 '(byte-compile-normal-call
4300 byte-compile-form
4301 byte-compile-body
4302 ;; Inserted some more than necessary, to speed it up.
4303 byte-compile-top-level
4304 byte-compile-out-toplevel
4305 byte-compile-constant
4306 byte-compile-variable-ref))))
4307 nil)
4308
4309 (run-hooks 'bytecomp-load-hook)
4310
4311 ;; arch-tag: 9c97b0f0-8745-4571-bfc3-8dceb677292a
4312 ;;; bytecomp.el ends here