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

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

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

;; This file is part of GNU Emacs.

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

;; 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
;; along with GNU Emacs; see the file COPYING.  If not, write to the
Lute Kamstra's avatar
Lute Kamstra committed
25 26
;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
;; Boston, MA 02110-1301, USA.
Juanma Barranquero's avatar
Juanma Barranquero committed
27 28 29 30 31 32 33 34

;;; Commentary:

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

;;; Code:

35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53
;; 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))
      (cond ((and (consp d) (eq (car d) 'indent))
	     (put macro 'lisp-indent-function (car (cdr d))))
	    ((and (consp d) (eq (car d) 'debug))
	     (put macro 'edebug-form-spec (car (cdr d))))
54 55
	    ((and (consp d) (eq (car d) 'doc-string))
	     (put macro 'doc-string-elt (car (cdr d))))
56 57 58 59 60 61
	    (t
	     (message "Unknown declaration %s" d))))))

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


Juanma Barranquero's avatar
Juanma Barranquero committed
62 63 64
;; Redefined in byte-optimize.el.
;; This is not documented--it's not clear that we should promote it.
(fset 'inline 'progn)
65
(put 'inline 'lisp-indent-function 0)
Juanma Barranquero's avatar
Juanma Barranquero committed
66 67 68 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

;;; 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'."
97
  (declare (debug defun))
Juanma Barranquero's avatar
Juanma Barranquero committed
98 99 100
  (or (memq (get name 'byte-optimizer)
	    '(nil byte-compile-inline-expand))
      (error "`%s' is a primitive" name))
101 102 103 104
  `(prog1
       (defun ,name ,arglist ,@body)
     (eval-and-compile
       (put ',name 'byte-optimizer 'byte-compile-inline-expand))))
Juanma Barranquero's avatar
Juanma Barranquero committed
105

Glenn Morris's avatar
Glenn Morris committed
106 107 108 109 110
(defmacro declare-function (fn file &optional arglist)
  "Tell the byte-compiler that function FN is defined, in FILE.
Optional ARGLIST is the argument list used by the function.  The
FILE argument is not used by the byte-compiler, but by the
`check-declare' package, which checks that FILE contains a
Glenn Morris's avatar
Glenn Morris committed
111 112 113 114
definition for FN.  ARGLIST is used by both the byte-compiler and
`check-declare' to check for consistency.

FILE can be either a Lisp file (in which case the \".el\"
Glenn Morris's avatar
Glenn Morris committed
115 116 117 118 119
extension is optional), or a C file.  C files are expanded
relative to the Emacs \"src/\" directory.  Lisp files are
searched for using `locate-library', and if that fails they are
expanded relative to the location of the file containing the
declaration.
Glenn Morris's avatar
Glenn Morris committed
120 121 122 123 124 125 126 127

Note that for the purposes of `check-declare', this statement
must be the first non-whitespace on a line, and everything up to
the end of FILE must be all on the same line.  For example:

\(declare-function c-end-of-defun \"progmodes/cc-cmds.el\"
                  \(&optional arg))"
  ;; Does nothing - byte-compile-declare-function does the work.
Jason Rumney's avatar
Jason Rumney committed
128
  nil)
Glenn Morris's avatar
Glenn Morris committed
129

130 131 132 133
(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.
If CURRENT-NAME is a string, that is the `use instead' message.
Juanma Barranquero's avatar
Juanma Barranquero committed
134 135 136
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: ")
137
  (let ((handler (get obsolete-name 'byte-compile)))
Juanma Barranquero's avatar
Juanma Barranquero committed
138
    (if (eq 'byte-compile-obsolete handler)
139 140 141 142
	(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)
Juanma Barranquero's avatar
Juanma Barranquero committed
143

144
(defmacro define-obsolete-function-alias (obsolete-name current-name
145
						   &optional when docstring)
146
  "Set OBSOLETE-NAME's function definition to CURRENT-NAME and mark it obsolete.
147 148 149 150 151 152 153 154 155

\(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."
156
  (declare (doc-string 4))
157
  `(progn
158 159
     (defalias ,obsolete-name ,current-name ,docstring)
     (make-obsolete ,obsolete-name ,current-name ,when)))
160

161 162 163 164
(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
165 166 167 168 169 170 171 172
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: ")))))
173 174
  (put obsolete-name 'byte-obsolete-variable (cons current-name when))
  obsolete-name)
Juanma Barranquero's avatar
Juanma Barranquero committed
175

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

\(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\")

See the docstrings of `defvaralias' and `make-obsolete-variable' or
Info node `(elisp)Variable Aliases' for more details."
189
  (declare (doc-string 4))
190
  `(progn
191
     (defvaralias ,obsolete-name ,current-name ,docstring)
192
     (make-obsolete-variable ,obsolete-name ,current-name ,when)))
193

Juanma Barranquero's avatar
Juanma Barranquero committed
194 195 196
(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."
197
  (declare (debug t) (indent 0))
Juanma Barranquero's avatar
Juanma Barranquero committed
198 199 200
  (list 'eval (list 'quote (if (cdr body) (cons 'progn body) (car body)))))


201 202 203 204
;; 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
205 206

(defmacro eval-when-compile (&rest body)
207 208 209
  "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'."
210
  (declare (debug t) (indent 0))
Juanma Barranquero's avatar
Juanma Barranquero committed
211 212 213 214 215 216
  ;; 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."
217
  (declare (debug t) (indent 0))
Juanma Barranquero's avatar
Juanma Barranquero committed
218 219 220
  ;; Remember, it's magic.
  (cons 'progn body))

221
(put 'with-no-warnings 'lisp-indent-function 0)
222
(defun with-no-warnings (&rest body)
Juanma Barranquero's avatar
Juanma Barranquero committed
223 224
  "Like `progn', but prevents compiler warnings in the body."
  ;; The implementation for the interpreter is basically trivial.
225
  (car (last body)))
Juanma Barranquero's avatar
Juanma Barranquero committed
226 227


228 229 230 231 232 233
;; 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
234

235
;; (put 'byte-compiler-options 'lisp-indent-function 0)
Juanma Barranquero's avatar
Juanma Barranquero committed
236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258
;; (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
;; 		      Legal elements: (callargs redefine free-vars unresolved)
;;   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)

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