byte-run.el 6.35 KB
Newer Older
1
;;; byte-run.el --- byte-compiler support for inlining
Eric S. Raymond's avatar
Eric S. Raymond committed
2

Eric S. Raymond's avatar
Eric S. Raymond committed
3 4
;; Copyright (C) 1992 Free Software Foundation, Inc.

Eric S. Raymond's avatar
Eric S. Raymond committed
5 6
;; Author: Jamie Zawinski <jwz@lucid.com>
;;	Hallvard Furuseth <hbf@ulrik.uio.no>
Richard M. Stallman's avatar
Richard M. Stallman committed
7
;; Maintainer: FSF
Eric S. Raymond's avatar
Eric S. Raymond committed
8 9
;; Keywords: internal

Jim Blandy's avatar
Jim Blandy committed
10 11 12 13
;; 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
Eric S. Raymond's avatar
Eric S. Raymond committed
14
;; the Free Software Foundation; either version 2, or (at your option)
Jim Blandy's avatar
Jim Blandy committed
15 16 17 18 19 20 21 22
;; 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
Erik Naggum's avatar
Erik Naggum committed
23 24 25
;; along with GNU Emacs; see the file COPYING.  If not, write to the
;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
;; Boston, MA 02111-1307, USA.
Jim Blandy's avatar
Jim Blandy committed
26

Eric S. Raymond's avatar
Eric S. Raymond committed
27
;;; Commentary:
Jim Blandy's avatar
Jim Blandy committed
28

Erik Naggum's avatar
Erik Naggum committed
29 30
;; interface to selectively inlining functions.
;; This only happens when source-code optimization is turned on.
Jim Blandy's avatar
Jim Blandy committed
31

Eric S. Raymond's avatar
Eric S. Raymond committed
32 33
;;; Code:

Jim Blandy's avatar
Jim Blandy committed
34
;; Redefined in byte-optimize.el.
Eric S. Raymond's avatar
Eric S. Raymond committed
35
;; This is not documented--it's not clear that we should promote it.
Jim Blandy's avatar
Jim Blandy committed
36 37 38 39 40 41
(fset 'inline 'progn)
(put 'inline 'lisp-indent-hook 0)


;;; Interface to inline functions.

Eric S. Raymond's avatar
Eric S. Raymond committed
42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65
;; (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)))
Jim Blandy's avatar
Jim Blandy committed
66 67 68

;; This has a special byte-hunk-handler in bytecomp.el.
(defmacro defsubst (name arglist &rest body)
Eric S. Raymond's avatar
Eric S. Raymond committed
69 70 71 72
  "Define an inline function.  The syntax is just like that of `defun'."
  (or (memq (get name 'byte-optimizer)
	    '(nil byte-compile-inline-expand))
      (error "`%s' is a primitive" name))
Jim Blandy's avatar
Jim Blandy committed
73 74
  (list 'prog1
	(cons 'defun (cons name (cons arglist body)))
Eric S. Raymond's avatar
Eric S. Raymond committed
75 76 77
	(list 'eval-and-compile
	      (list 'put (list 'quote name)
		    ''byte-optimizer ''byte-compile-inline-expand))))
Jim Blandy's avatar
Jim Blandy committed
78

79
(defun make-obsolete (fn new &optional when)
Eric S. Raymond's avatar
Eric S. Raymond committed
80 81
  "Make the byte-compiler warn that FUNCTION is obsolete.
The warning will say that NEW should be used instead.
82 83 84
If NEW is a string, that is the `use instead' message.
If provided, WHEN should be a string indicating when the function
was first made obsolete, for example a date or a release number."
Jim Blandy's avatar
Jim Blandy committed
85 86 87
  (interactive "aMake function obsolete: \nxObsoletion replacement: ")
  (let ((handler (get fn 'byte-compile)))
    (if (eq 'byte-compile-obsolete handler)
88 89 90
	(setq handler (nth 1 (get fn 'byte-obsolete-info)))
      (put fn 'byte-compile 'byte-compile-obsolete))
    (put fn 'byte-obsolete-info (list new handler when)))
Jim Blandy's avatar
Jim Blandy committed
91 92
  fn)

93
(defun make-obsolete-variable (var new &optional when)
Jim Blandy's avatar
Jim Blandy committed
94 95
  "Make the byte-compiler warn that VARIABLE is obsolete,
and NEW should be used instead.  If NEW is a string, then that is the
96 97 98
`use instead' message.
If provided, WHEN should be a string indicating when the variable
was first made obsolete, for example a date or a release number."
Jim Blandy's avatar
Jim Blandy committed
99 100 101 102 103 104
  (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: ")))))
105
  (put var 'byte-obsolete-variable (cons new when))
Jim Blandy's avatar
Jim Blandy committed
106 107
  var)

Jim Blandy's avatar
Jim Blandy committed
108 109
(put 'dont-compile 'lisp-indent-hook 0)
(defmacro dont-compile (&rest body)
Jim Blandy's avatar
Jim Blandy committed
110 111
  "Like `progn', but the body always runs interpreted (not compiled).
If you think you need this, you're probably making a mistake somewhere."
Jim Blandy's avatar
Jim Blandy committed
112 113 114 115 116 117 118 119 120 121
  (list 'eval (list 'quote (if (cdr body) (cons 'progn body) (car body)))))


;;; 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.

(put 'eval-when-compile 'lisp-indent-hook 0)
(defmacro eval-when-compile (&rest body)
Eric S. Raymond's avatar
Eric S. Raymond committed
122 123
  "Like `progn', but evaluates the body at compile time.
The result of the body appears to the compiler as a quoted constant."
Jim Blandy's avatar
Jim Blandy committed
124 125 126 127 128 129
  ;; Not necessary because we have it in b-c-initial-macro-environment
  ;; (list 'quote (eval (cons 'progn body)))
  (cons 'progn body))

(put 'eval-and-compile 'lisp-indent-hook 0)
(defmacro eval-and-compile (&rest body)
Eric S. Raymond's avatar
Eric S. Raymond committed
130
  "Like `progn', but evaluates the body at compile time and at load time."
Jim Blandy's avatar
Jim Blandy committed
131 132 133 134
  ;; Remember, it's magic.
  (cons 'progn body))


Eric S. Raymond's avatar
Eric S. Raymond committed
135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166
;;; 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.

;; (put 'byte-compiler-options 'lisp-indent-hook 0)
;; (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)

;;; byte-run.el ends here