1;;; byte-run.el --- byte-compiler support for inlining
2
3;; Copyright (C) 1992, 2001, 2002, 2003, 2004, 2005,
4;;   2006, 2007 Free Software Foundation, Inc.
5
6;; Author: Jamie Zawinski <jwz@lucid.com>
7;;	Hallvard Furuseth <hbf@ulrik.uio.no>
8;; Maintainer: FSF
9;; Keywords: internal
10
11;; This file is part of GNU Emacs.
12
13;; GNU Emacs is free software; you can redistribute it and/or modify
14;; it under the terms of the GNU General Public License as published by
15;; the Free Software Foundation; either version 2, or (at your option)
16;; any later version.
17
18;; GNU Emacs is distributed in the hope that it will be useful,
19;; but WITHOUT ANY WARRANTY; without even the implied warranty of
20;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
21;; GNU General Public License for more details.
22
23;; You should have received a copy of the GNU General Public License
24;; along with GNU Emacs; see the file COPYING.  If not, write to the
25;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
26;; Boston, MA 02110-1301, USA.
27
28;;; Commentary:
29
30;; interface to selectively inlining functions.
31;; This only happens when source-code optimization is turned on.
32
33;;; Code:
34
35;; We define macro-declaration-function here because it is needed to
36;; handle declarations in macro definitions and this is the first file
37;; loaded by loadup.el that uses declarations in macros.
38
39(defun macro-declaration-function (macro decl)
40  "Process a declaration found in a macro definition.
41This is set as the value of the variable `macro-declaration-function'.
42MACRO is the name of the macro being defined.
43DECL is a list `(declare ...)' containing the declarations.
44The return value of this function is not used."
45  ;; We can't use `dolist' or `cadr' yet for bootstrapping reasons.
46  (let (d)
47    ;; Ignore the first element of `decl' (it's always `declare').
48    (while (setq decl (cdr decl))
49      (setq d (car decl))
50      (cond ((and (consp d) (eq (car d) 'indent))
51	     (put macro 'lisp-indent-function (car (cdr d))))
52	    ((and (consp d) (eq (car d) 'debug))
53	     (put macro 'edebug-form-spec (car (cdr d))))
54	    ((and (consp d) (eq (car d) 'doc-string))
55	     (put macro 'doc-string-elt (car (cdr d))))
56	    (t
57	     (message "Unknown declaration %s" d))))))
58
59(setq macro-declaration-function 'macro-declaration-function)
60
61
62;; Redefined in byte-optimize.el.
63;; This is not documented--it's not clear that we should promote it.
64(fset 'inline 'progn)
65(put 'inline 'lisp-indent-function 0)
66
67;;; Interface to inline functions.
68
69;; (defmacro proclaim-inline (&rest fns)
70;;   "Cause the named functions to be open-coded when called from compiled code.
71;; They will only be compiled open-coded when byte-compile-optimize is true."
72;;   (cons 'eval-and-compile
73;; 	(mapcar '(lambda (x)
74;; 		   (or (memq (get x 'byte-optimizer)
75;; 			     '(nil byte-compile-inline-expand))
76;; 		       (error
77;; 			"%s already has a byte-optimizer, can't make it inline"
78;; 			x))
79;; 		   (list 'put (list 'quote x)
80;; 			 ''byte-optimizer ''byte-compile-inline-expand))
81;; 		fns)))
82
83;; (defmacro proclaim-notinline (&rest fns)
84;;   "Cause the named functions to no longer be open-coded."
85;;   (cons 'eval-and-compile
86;; 	(mapcar '(lambda (x)
87;; 		   (if (eq (get x 'byte-optimizer) 'byte-compile-inline-expand)
88;; 		       (put x 'byte-optimizer nil))
89;; 		   (list 'if (list 'eq (list 'get (list 'quote x) ''byte-optimizer)
90;; 				   ''byte-compile-inline-expand)
91;; 			 (list 'put x ''byte-optimizer nil)))
92;; 		fns)))
93
94;; This has a special byte-hunk-handler in bytecomp.el.
95(defmacro defsubst (name arglist &rest body)
96  "Define an inline function.  The syntax is just like that of `defun'."
97  (declare (debug defun))
98  (or (memq (get name 'byte-optimizer)
99	    '(nil byte-compile-inline-expand))
100      (error "`%s' is a primitive" name))
101  `(prog1
102       (defun ,name ,arglist ,@body)
103     (eval-and-compile
104       (put ',name 'byte-optimizer 'byte-compile-inline-expand))))
105
106(defun make-obsolete (obsolete-name current-name &optional when)
107  "Make the byte-compiler warn that OBSOLETE-NAME is obsolete.
108The warning will say that CURRENT-NAME should be used instead.
109If CURRENT-NAME is a string, that is the `use instead' message.
110If provided, WHEN should be a string indicating when the function
111was first made obsolete, for example a date or a release number."
112  (interactive "aMake function obsolete: \nxObsoletion replacement: ")
113  (let ((handler (get obsolete-name 'byte-compile)))
114    (if (eq 'byte-compile-obsolete handler)
115	(setq handler (nth 1 (get obsolete-name 'byte-obsolete-info)))
116      (put obsolete-name 'byte-compile 'byte-compile-obsolete))
117    (put obsolete-name 'byte-obsolete-info (list current-name handler when)))
118  obsolete-name)
119
120(defmacro define-obsolete-function-alias (obsolete-name current-name
121						   &optional when docstring)
122  "Set OBSOLETE-NAME's function definition to CURRENT-NAME and mark it obsolete.
123
124\(define-obsolete-function-alias 'old-fun 'new-fun \"22.1\" \"old-fun's doc.\")
125
126is equivalent to the following two lines of code:
127
128\(defalias 'old-fun 'new-fun \"old-fun's doc.\")
129\(make-obsolete 'old-fun 'new-fun \"22.1\")
130
131See the docstrings of `defalias' and `make-obsolete' for more details."
132  (declare (doc-string 4))
133  `(progn
134     (defalias ,obsolete-name ,current-name ,docstring)
135     (make-obsolete ,obsolete-name ,current-name ,when)))
136
137(defun make-obsolete-variable (obsolete-name current-name &optional when)
138  "Make the byte-compiler warn that OBSOLETE-NAME is obsolete.
139The warning will say that CURRENT-NAME should be used instead.
140If CURRENT-NAME is a string, that is the `use instead' message.
141If provided, WHEN should be a string indicating when the variable
142was first made obsolete, for example a date or a release number."
143  (interactive
144   (list
145    (let ((str (completing-read "Make variable obsolete: " obarray 'boundp t)))
146      (if (equal str "") (error ""))
147      (intern str))
148    (car (read-from-string (read-string "Obsoletion replacement: ")))))
149  (put obsolete-name 'byte-obsolete-variable (cons current-name when))
150  obsolete-name)
151
152(defmacro define-obsolete-variable-alias (obsolete-name current-name
153						 &optional when docstring)
154  "Make OBSOLETE-NAME a variable alias for CURRENT-NAME and mark it obsolete.
155
156\(define-obsolete-variable-alias 'old-var 'new-var \"22.1\" \"old-var's doc.\")
157
158is equivalent to the following two lines of code:
159
160\(defvaralias 'old-var 'new-var \"old-var's doc.\")
161\(make-obsolete-variable 'old-var 'new-var \"22.1\")
162
163See the docstrings of `defvaralias' and `make-obsolete-variable' or
164Info node `(elisp)Variable Aliases' for more details."
165  (declare (doc-string 4))
166  `(progn
167     (defvaralias ,obsolete-name ,current-name ,docstring)
168     (make-obsolete-variable ,obsolete-name ,current-name ,when)))
169
170(defmacro dont-compile (&rest body)
171  "Like `progn', but the body always runs interpreted (not compiled).
172If you think you need this, you're probably making a mistake somewhere."
173  (declare (debug t) (indent 0))
174  (list 'eval (list 'quote (if (cdr body) (cons 'progn body) (car body)))))
175
176
177;; interface to evaluating things at compile time and/or load time
178;; these macro must come after any uses of them in this file, as their
179;; definition in the file overrides the magic definitions on the
180;; byte-compile-macro-environment.
181
182(defmacro eval-when-compile (&rest body)
183  "Like `progn', but evaluates the body at compile time if you're compiling.
184Thus, the result of the body appears to the compiler as a quoted constant.
185In interpreted code, this is entirely equivalent to `progn'."
186  (declare (debug t) (indent 0))
187  ;; Not necessary because we have it in b-c-initial-macro-environment
188  ;; (list 'quote (eval (cons 'progn body)))
189  (cons 'progn body))
190
191(defmacro eval-and-compile (&rest body)
192  "Like `progn', but evaluates the body at compile time and at load time."
193  (declare (debug t) (indent 0))
194  ;; Remember, it's magic.
195  (cons 'progn body))
196
197(put 'with-no-warnings 'lisp-indent-function 0)
198(defun with-no-warnings (&rest body)
199  "Like `progn', but prevents compiler warnings in the body."
200  ;; The implementation for the interpreter is basically trivial.
201  (car (last body)))
202
203
204;; I nuked this because it's not a good idea for users to think of using it.
205;; These options are a matter of installation preference, and have nothing to
206;; with particular source files; it's a mistake to suggest to users
207;; they should associate these with particular source files.
208;; There is hardly any reason to change these parameters, anyway.
209;; --rms.
210
211;; (put 'byte-compiler-options 'lisp-indent-function 0)
212;; (defmacro byte-compiler-options (&rest args)
213;;   "Set some compilation-parameters for this file.  This will affect only the
214;; file in which it appears; this does nothing when evaluated, and when loaded
215;; from a .el file.
216;;
217;; Each argument to this macro must be a list of a key and a value.
218;;
219;;   Keys:		  Values:		Corresponding variable:
220;;
221;;   verbose	  t, nil		byte-compile-verbose
222;;   optimize	  t, nil, source, byte	byte-compile-optimize
223;;   warnings	  list of warnings	byte-compile-warnings
224;; 		      Legal elements: (callargs redefine free-vars unresolved)
225;;   file-format	  emacs18, emacs19	byte-compile-compatibility
226;;
227;; For example, this might appear at the top of a source file:
228;;
229;;     (byte-compiler-options
230;;       (optimize t)
231;;       (warnings (- free-vars))		; Don't warn about free variables
232;;       (file-format emacs19))"
233;;   nil)
234
235;; arch-tag: 76f8328a-1f66-4df2-9b6d-5c3666dc05e9
236;;; byte-run.el ends here
237