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