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