lisp/emacs-lisp/byte-run.el

   1 ;;; byte-run.el --- byte-compiler support for inlining
   2
   3 ;; Copyright (C) 1992, 2001, 2002, 2003, 2004, 2005,
   4 ;;   2006, 2007, 2008 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 3, 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.
  41 This is set as the value of the variable `macro-declaration-function'.
  42 MACRO is the name of the macro being defined.
  43 DECL is a list `(declare ...)' containing the declarations.
  44 The 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 \f
  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 (defmacro declare-function (&rest args)
 107   "In Emacs 22, does nothing.  In 23, it will suppress byte-compiler warnings.
 108 This definition is so that packages may take advantage of the
 109 Emacs 23 feature and still remain compatible with Emacs 22."
 110   nil)
 111
 112 (defun make-obsolete (obsolete-name current-name &optional when)
 113   "Make the byte-compiler warn that OBSOLETE-NAME is obsolete.
 114 The warning will say that CURRENT-NAME should be used instead.
 115 If CURRENT-NAME is a string, that is the `use instead' message.
 116 If provided, WHEN should be a string indicating when the function
 117 was first made obsolete, for example a date or a release number."
 118   (interactive "aMake function obsolete: \nxObsoletion replacement: ")
 119   (let ((handler (get obsolete-name 'byte-compile)))
 120     (if (eq 'byte-compile-obsolete handler)
 121         (setq handler (nth 1 (get obsolete-name 'byte-obsolete-info)))
 122       (put obsolete-name 'byte-compile 'byte-compile-obsolete))
 123     (put obsolete-name 'byte-obsolete-info (list current-name handler when)))
 124   obsolete-name)
 125
 126 (defmacro define-obsolete-function-alias (obsolete-name current-name
 127                                                    &optional when docstring)
 128   "Set OBSOLETE-NAME's function definition to CURRENT-NAME and mark it obsolete.
 129
 130 \(define-obsolete-function-alias 'old-fun 'new-fun \"22.1\" \"old-fun's doc.\")
 131
 132 is equivalent to the following two lines of code:
 133
 134 \(defalias 'old-fun 'new-fun \"old-fun's doc.\")
 135 \(make-obsolete 'old-fun 'new-fun \"22.1\")
 136
 137 See the docstrings of `defalias' and `make-obsolete' for more details."
 138   (declare (doc-string 4))
 139   `(progn
 140      (defalias ,obsolete-name ,current-name ,docstring)
 141      (make-obsolete ,obsolete-name ,current-name ,when)))
 142
 143 (defun make-obsolete-variable (obsolete-name current-name &optional when)
 144   "Make the byte-compiler warn that OBSOLETE-NAME is obsolete.
 145 The warning will say that CURRENT-NAME should be used instead.
 146 If CURRENT-NAME is a string, that is the `use instead' message.
 147 If provided, WHEN should be a string indicating when the variable
 148 was first made obsolete, for example a date or a release number."
 149   (interactive
 150    (list
 151     (let ((str (completing-read "Make variable obsolete: " obarray 'boundp t)))
 152       (if (equal str "") (error ""))
 153       (intern str))
 154     (car (read-from-string (read-string "Obsoletion replacement: ")))))
 155   (put obsolete-name 'byte-obsolete-variable (cons current-name when))
 156   obsolete-name)
 157
 158 (defmacro define-obsolete-variable-alias (obsolete-name current-name
 159                                                  &optional when docstring)
 160   "Make OBSOLETE-NAME a variable alias for CURRENT-NAME and mark it obsolete.
 161
 162 \(define-obsolete-variable-alias 'old-var 'new-var \"22.1\" \"old-var's doc.\")
 163
 164 is equivalent to the following two lines of code:
 165
 166 \(defvaralias 'old-var 'new-var \"old-var's doc.\")
 167 \(make-obsolete-variable 'old-var 'new-var \"22.1\")
 168
 169 See the docstrings of `defvaralias' and `make-obsolete-variable' or
 170 Info node `(elisp)Variable Aliases' for more details."
 171   (declare (doc-string 4))
 172   `(progn
 173      (defvaralias ,obsolete-name ,current-name ,docstring)
 174      (make-obsolete-variable ,obsolete-name ,current-name ,when)))
 175
 176 (defmacro dont-compile (&rest body)
 177   "Like `progn', but the body always runs interpreted (not compiled).
 178 If you think you need this, you're probably making a mistake somewhere."
 179   (declare (debug t) (indent 0))
 180   (list 'eval (list 'quote (if (cdr body) (cons 'progn body) (car body)))))
 181
 182 \f
 183 ;; interface to evaluating things at compile time and/or load time
 184 ;; these macro must come after any uses of them in this file, as their
 185 ;; definition in the file overrides the magic definitions on the
 186 ;; byte-compile-macro-environment.
 187
 188 (defmacro eval-when-compile (&rest body)
 189   "Like `progn', but evaluates the body at compile time if you're compiling.
 190 Thus, the result of the body appears to the compiler as a quoted constant.
 191 In interpreted code, this is entirely equivalent to `progn'."
 192   (declare (debug t) (indent 0))
 193   ;; Not necessary because we have it in b-c-initial-macro-environment
 194   ;; (list 'quote (eval (cons 'progn body)))
 195   (cons 'progn body))
 196
 197 (defmacro eval-and-compile (&rest body)
 198   "Like `progn', but evaluates the body at compile time and at load time."
 199   (declare (debug t) (indent 0))
 200   ;; Remember, it's magic.
 201   (cons 'progn body))
 202
 203 (put 'with-no-warnings 'lisp-indent-function 0)
 204 (defun with-no-warnings (&rest body)
 205   "Like `progn', but prevents compiler warnings in the body."
 206   ;; The implementation for the interpreter is basically trivial.
 207   (car (last body)))
 208
 209 \f
 210 ;; I nuked this because it's not a good idea for users to think of using it.
 211 ;; These options are a matter of installation preference, and have nothing to
 212 ;; with particular source files; it's a mistake to suggest to users
 213 ;; they should associate these with particular source files.
 214 ;; There is hardly any reason to change these parameters, anyway.
 215 ;; --rms.
 216
 217 ;; (put 'byte-compiler-options 'lisp-indent-function 0)
 218 ;; (defmacro byte-compiler-options (&rest args)
 219 ;;   "Set some compilation-parameters for this file.  This will affect only the
 220 ;; file in which it appears; this does nothing when evaluated, and when loaded
 221 ;; from a .el file.
 222 ;;
 223 ;; Each argument to this macro must be a list of a key and a value.
 224 ;;
 225 ;;   Keys:                Values:               Corresponding variable:
 226 ;;
 227 ;;   verbose      t, nil                byte-compile-verbose
 228 ;;   optimize     t, nil, source, byte  byte-compile-optimize
 229 ;;   warnings     list of warnings      byte-compile-warnings
 230 ;;                    Valid elements: (callargs redefine free-vars unresolved)
 231 ;;   file-format          emacs18, emacs19      byte-compile-compatibility
 232 ;;
 233 ;; For example, this might appear at the top of a source file:
 234 ;;
 235 ;;     (byte-compiler-options
 236 ;;       (optimize t)
 237 ;;       (warnings (- free-vars))               ; Don't warn about free variables
 238 ;;       (file-format emacs19))"
 239 ;;   nil)
 240
 241 ;; arch-tag: 76f8328a-1f66-4df2-9b6d-5c3666dc05e9
 242 ;;; byte-run.el ends here