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