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