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