byte-run.el 11.6 KB
Newer Older
Juanma Barranquero's avatar
Juanma Barranquero committed
1 2
;;; byte-run.el --- byte-compiler support for inlining

3 4
;; Copyright (C) 1992, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008,
;;   2009  Free Software Foundation, Inc.
Juanma Barranquero's avatar
Juanma Barranquero committed
5 6 7 8 9 10 11 12

;; Author: Jamie Zawinski <jwz@lucid.com>
;;	Hallvard Furuseth <hbf@ulrik.uio.no>
;; Maintainer: FSF
;; Keywords: internal

;; This file is part of GNU Emacs.

13
;; GNU Emacs is free software: you can redistribute it and/or modify
Juanma Barranquero's avatar
Juanma Barranquero committed
14
;; it under the terms of the GNU General Public License as published by
15 16
;; the Free Software Foundation, either version 3 of the License, or
;; (at your option) any later version.
Juanma Barranquero's avatar
Juanma Barranquero committed
17 18 19 20 21 22 23

;; GNU Emacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
;; GNU General Public License for more details.

;; You should have received a copy of the GNU General Public License
24
;; along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.
Juanma Barranquero's avatar
Juanma Barranquero committed
25 26 27 28 29 30 31 32

;;; Commentary:

;; interface to selectively inlining functions.
;; This only happens when source-code optimization is turned on.

;;; Code:

33 34 35 36 37 38 39 40 41 42 43 44 45 46 47
;; We define macro-declaration-function here because it is needed to
;; handle declarations in macro definitions and this is the first file
;; loaded by loadup.el that uses declarations in macros.

(defun macro-declaration-function (macro decl)
  "Process a declaration found in a macro definition.
This is set as the value of the variable `macro-declaration-function'.
MACRO is the name of the macro being defined.
DECL is a list `(declare ...)' containing the declarations.
The return value of this function is not used."
  ;; We can't use `dolist' or `cadr' yet for bootstrapping reasons.
  (let (d)
    ;; Ignore the first element of `decl' (it's always `declare').
    (while (setq decl (cdr decl))
      (setq d (car decl))
48 49 50 51 52 53 54 55 56 57 58 59 60
      (if (and (consp d)
	       (listp (cdr d))
	       (null (cdr (cdr d))))
	  (cond ((eq (car d) 'indent)
		 (put macro 'lisp-indent-function (car (cdr d))))
		((eq (car d) 'debug)
		 (put macro 'edebug-form-spec (car (cdr d))))
		((eq (car d) 'doc-string)
		 (put macro 'doc-string-elt (car (cdr d))))
		(t
		 (message "Unknown declaration %s" d)))
	(message "Invalid declaration %s" d)))))

61 62 63 64

(setq macro-declaration-function 'macro-declaration-function)


Juanma Barranquero's avatar
Juanma Barranquero committed
65 66 67
;; Redefined in byte-optimize.el.
;; This is not documented--it's not clear that we should promote it.
(fset 'inline 'progn)
68
(put 'inline 'lisp-indent-function 0)
Juanma Barranquero's avatar
Juanma Barranquero committed
69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99

;;; Interface to inline functions.

;; (defmacro proclaim-inline (&rest fns)
;;   "Cause the named functions to be open-coded when called from compiled code.
;; They will only be compiled open-coded when byte-compile-optimize is true."
;;   (cons 'eval-and-compile
;; 	(mapcar '(lambda (x)
;; 		   (or (memq (get x 'byte-optimizer)
;; 			     '(nil byte-compile-inline-expand))
;; 		       (error
;; 			"%s already has a byte-optimizer, can't make it inline"
;; 			x))
;; 		   (list 'put (list 'quote x)
;; 			 ''byte-optimizer ''byte-compile-inline-expand))
;; 		fns)))

;; (defmacro proclaim-notinline (&rest fns)
;;   "Cause the named functions to no longer be open-coded."
;;   (cons 'eval-and-compile
;; 	(mapcar '(lambda (x)
;; 		   (if (eq (get x 'byte-optimizer) 'byte-compile-inline-expand)
;; 		       (put x 'byte-optimizer nil))
;; 		   (list 'if (list 'eq (list 'get (list 'quote x) ''byte-optimizer)
;; 				   ''byte-compile-inline-expand)
;; 			 (list 'put x ''byte-optimizer nil)))
;; 		fns)))

;; This has a special byte-hunk-handler in bytecomp.el.
(defmacro defsubst (name arglist &rest body)
  "Define an inline function.  The syntax is just like that of `defun'."
100
  (declare (debug defun))
Juanma Barranquero's avatar
Juanma Barranquero committed
101 102 103
  (or (memq (get name 'byte-optimizer)
	    '(nil byte-compile-inline-expand))
      (error "`%s' is a primitive" name))
104 105 106 107
  `(prog1
       (defun ,name ,arglist ,@body)
     (eval-and-compile
       (put ',name 'byte-optimizer 'byte-compile-inline-expand))))
Juanma Barranquero's avatar
Juanma Barranquero committed
108

109 110 111 112 113 114 115 116 117
(defvar advertised-signature-table (make-hash-table :test 'eq :weakness 'key))

(defun set-advertised-calling-convention (function signature)
  "Set the advertised SIGNATURE of FUNCTION.
This will allow the byte-compiler to warn the programmer when she uses
an obsolete calling convention."
  (puthash (indirect-function function) signature
           advertised-signature-table))

118 119 120
(defun make-obsolete (obsolete-name current-name &optional when)
  "Make the byte-compiler warn that OBSOLETE-NAME is obsolete.
The warning will say that CURRENT-NAME should be used instead.
Glenn Morris's avatar
Glenn Morris committed
121 122
If CURRENT-NAME is a string, that is the `use instead' message
\(it should end with a period, and not start with a capital).
Juanma Barranquero's avatar
Juanma Barranquero committed
123 124 125
If provided, WHEN should be a string indicating when the function
was first made obsolete, for example a date or a release number."
  (interactive "aMake function obsolete: \nxObsoletion replacement: ")
126
  (let ((handler (get obsolete-name 'byte-compile)))
Juanma Barranquero's avatar
Juanma Barranquero committed
127
    (if (eq 'byte-compile-obsolete handler)
128 129 130 131
	(setq handler (nth 1 (get obsolete-name 'byte-obsolete-info)))
      (put obsolete-name 'byte-compile 'byte-compile-obsolete))
    (put obsolete-name 'byte-obsolete-info (list current-name handler when)))
  obsolete-name)
132 133 134
(set-advertised-calling-convention
 ;; New code should always provide the `when' argument.
 'make-obsolete '(obsolete-name current-name when))
Juanma Barranquero's avatar
Juanma Barranquero committed
135

136
(defmacro define-obsolete-function-alias (obsolete-name current-name
137
						   &optional when docstring)
138
  "Set OBSOLETE-NAME's function definition to CURRENT-NAME and mark it obsolete.
139 140 141 142 143 144 145 146 147

\(define-obsolete-function-alias 'old-fun 'new-fun \"22.1\" \"old-fun's doc.\")

is equivalent to the following two lines of code:

\(defalias 'old-fun 'new-fun \"old-fun's doc.\")
\(make-obsolete 'old-fun 'new-fun \"22.1\")

See the docstrings of `defalias' and `make-obsolete' for more details."
148
  (declare (doc-string 4))
149
  `(progn
150 151
     (defalias ,obsolete-name ,current-name ,docstring)
     (make-obsolete ,obsolete-name ,current-name ,when)))
152 153 154 155
(set-advertised-calling-convention
 ;; New code should always provide the `when' argument.
 'define-obsolete-function-alias
 '(obsolete-name current-name when &optional docstring))
156

157 158 159 160
(defun make-obsolete-variable (obsolete-name current-name &optional when)
  "Make the byte-compiler warn that OBSOLETE-NAME is obsolete.
The warning will say that CURRENT-NAME should be used instead.
If CURRENT-NAME is a string, that is the `use instead' message.
Juanma Barranquero's avatar
Juanma Barranquero committed
161 162 163 164 165 166 167 168
If provided, WHEN should be a string indicating when the variable
was first made obsolete, for example a date or a release number."
  (interactive
   (list
    (let ((str (completing-read "Make variable obsolete: " obarray 'boundp t)))
      (if (equal str "") (error ""))
      (intern str))
    (car (read-from-string (read-string "Obsoletion replacement: ")))))
169 170
  (put obsolete-name 'byte-obsolete-variable (cons current-name when))
  obsolete-name)
171 172 173
(set-advertised-calling-convention
 ;; New code should always provide the `when' argument.
 'make-obsolete-variable '(obsolete-name current-name when))
Juanma Barranquero's avatar
Juanma Barranquero committed
174

175
(defmacro define-obsolete-variable-alias (obsolete-name current-name
176
						 &optional when docstring)
177
  "Make OBSOLETE-NAME a variable alias for CURRENT-NAME and mark it obsolete.
178 179 180 181 182 183 184 185

\(define-obsolete-variable-alias 'old-var 'new-var \"22.1\" \"old-var's doc.\")

is equivalent to the following two lines of code:

\(defvaralias 'old-var 'new-var \"old-var's doc.\")
\(make-obsolete-variable 'old-var 'new-var \"22.1\")

186 187 188 189 190 191 192 193 194
If CURRENT-NAME is a defcustom (more generally, any variable
where OBSOLETE-NAME may be set, e.g. in a .emacs file, before the
alias is defined), then the define-obsolete-variable-alias
statement should be placed before the defcustom.  This is so that
any user customizations are applied before the defcustom tries to
initialize the variable (this is due to the way `defvaralias' works).
Exceptions to this rule occur for define-obsolete-variable-alias
statements that are autoloaded, or in files dumped with Emacs.

195 196
See the docstrings of `defvaralias' and `make-obsolete-variable' or
Info node `(elisp)Variable Aliases' for more details."
197
  (declare (doc-string 4))
198
  `(progn
199
     (defvaralias ,obsolete-name ,current-name ,docstring)
200
     (make-obsolete-variable ,obsolete-name ,current-name ,when)))
201 202 203 204
(set-advertised-calling-convention
 ;; New code should always provide the `when' argument.
 'define-obsolete-variable-alias
 '(obsolete-name current-name when &optional docstring))
205

206 207 208 209 210
;; FIXME This is only defined in this file because the variable- and
;; function- versions are too.  Unlike those two, this one is not used
;; by the byte-compiler (would be nice if it could warn about obsolete
;; faces, but it doesn't really do anything special with faces).
;; It only really affects M-x describe-face output.
211
(defmacro define-obsolete-face-alias (obsolete-face current-face when)
212
  "Make OBSOLETE-FACE a face alias for CURRENT-FACE and mark it obsolete.
213 214
The string WHEN gives the Emacs version where OBSOLETE-FACE became
obsolete."
215 216 217 218 219
  `(progn
     (put ,obsolete-face 'face-alias ,current-face)
     ;; Used by M-x describe-face.
     (put ,obsolete-face 'obsolete-face (or ,when t))))

Juanma Barranquero's avatar
Juanma Barranquero committed
220 221 222
(defmacro dont-compile (&rest body)
  "Like `progn', but the body always runs interpreted (not compiled).
If you think you need this, you're probably making a mistake somewhere."
223
  (declare (debug t) (indent 0))
Juanma Barranquero's avatar
Juanma Barranquero committed
224 225 226
  (list 'eval (list 'quote (if (cdr body) (cons 'progn body) (car body)))))


227 228 229 230
;; interface to evaluating things at compile time and/or load time
;; these macro must come after any uses of them in this file, as their
;; definition in the file overrides the magic definitions on the
;; byte-compile-macro-environment.
Juanma Barranquero's avatar
Juanma Barranquero committed
231 232

(defmacro eval-when-compile (&rest body)
233 234 235
  "Like `progn', but evaluates the body at compile time if you're compiling.
Thus, the result of the body appears to the compiler as a quoted constant.
In interpreted code, this is entirely equivalent to `progn'."
236
  (declare (debug t) (indent 0))
Juanma Barranquero's avatar
Juanma Barranquero committed
237 238 239 240 241 242
  ;; Not necessary because we have it in b-c-initial-macro-environment
  ;; (list 'quote (eval (cons 'progn body)))
  (cons 'progn body))

(defmacro eval-and-compile (&rest body)
  "Like `progn', but evaluates the body at compile time and at load time."
243
  (declare (debug t) (indent 0))
Juanma Barranquero's avatar
Juanma Barranquero committed
244 245 246
  ;; Remember, it's magic.
  (cons 'progn body))

247
(put 'with-no-warnings 'lisp-indent-function 0)
248
(defun with-no-warnings (&rest body)
Juanma Barranquero's avatar
Juanma Barranquero committed
249 250
  "Like `progn', but prevents compiler warnings in the body."
  ;; The implementation for the interpreter is basically trivial.
251
  (car (last body)))
Juanma Barranquero's avatar
Juanma Barranquero committed
252 253


254 255 256 257 258 259
;; I nuked this because it's not a good idea for users to think of using it.
;; These options are a matter of installation preference, and have nothing to
;; with particular source files; it's a mistake to suggest to users
;; they should associate these with particular source files.
;; There is hardly any reason to change these parameters, anyway.
;; --rms.
Juanma Barranquero's avatar
Juanma Barranquero committed
260

261
;; (put 'byte-compiler-options 'lisp-indent-function 0)
Juanma Barranquero's avatar
Juanma Barranquero committed
262 263 264 265 266 267 268 269 270 271 272 273
;; (defmacro byte-compiler-options (&rest args)
;;   "Set some compilation-parameters for this file.  This will affect only the
;; file in which it appears; this does nothing when evaluated, and when loaded
;; from a .el file.
;;
;; Each argument to this macro must be a list of a key and a value.
;;
;;   Keys:		  Values:		Corresponding variable:
;;
;;   verbose	  t, nil		byte-compile-verbose
;;   optimize	  t, nil, source, byte	byte-compile-optimize
;;   warnings	  list of warnings	byte-compile-warnings
Juanma Barranquero's avatar
Juanma Barranquero committed
274
;; 		      Valid elements: (callargs redefine free-vars unresolved)
Juanma Barranquero's avatar
Juanma Barranquero committed
275 276 277 278 279 280 281 282 283 284
;;   file-format	  emacs18, emacs19	byte-compile-compatibility
;;
;; For example, this might appear at the top of a source file:
;;
;;     (byte-compiler-options
;;       (optimize t)
;;       (warnings (- free-vars))		; Don't warn about free variables
;;       (file-format emacs19))"
;;   nil)

285
;; arch-tag: 76f8328a-1f66-4df2-9b6d-5c3666dc05e9
Juanma Barranquero's avatar
Juanma Barranquero committed
286
;;; byte-run.el ends here