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