*** empty log message ***
[emacs.git] / lisp / byte-run.el
blob785a89b977dbb1c92d54bbe9f0153ece4310172c
1 ;; byte-run.el --- byte-compiler support for inlining
3 ;; Author: Jamie Zawinski <jwz@lucid.com>
4 ;; Hallvard Furuseth <hbf@ulrik.uio.no>
5 ;; Last-Modified: 13 Jul 1992
6 ;; Keywords: internal
8 ;; Copyright (C) 1992 Free Software Foundation, Inc.
10 ;; This file is part of GNU Emacs.
12 ;; GNU Emacs is free software; you can redistribute it and/or modify
13 ;; it under the terms of the GNU General Public License as published by
14 ;; the Free Software Foundation; either version 2, or (at your option)
15 ;; any later version.
17 ;; GNU Emacs is distributed in the hope that it will be useful,
18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 ;; GNU General Public License for more details.
22 ;; You should have received a copy of the GNU General Public License
23 ;; along with GNU Emacs; see the file COPYING. If not, write to
24 ;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
26 ;;; Commentary:
28 ;;; interface to selectively inlining functions.
29 ;;; This only happens when source-code optimization is turned on.
31 ;;; Code:
33 ;; Redefined in byte-optimize.el.
34 ;; This is not documented--it's not clear that we should promote it.
35 (fset 'inline 'progn)
36 (put 'inline 'lisp-indent-hook 0)
39 ;;; Interface to inline functions.
41 ;; (defmacro proclaim-inline (&rest fns)
42 ;; "Cause the named functions to be open-coded when called from compiled code.
43 ;; They will only be compiled open-coded when byte-compile-optimize is true."
44 ;; (cons 'eval-and-compile
45 ;; (mapcar '(lambda (x)
46 ;; (or (memq (get x 'byte-optimizer)
47 ;; '(nil byte-compile-inline-expand))
48 ;; (error
49 ;; "%s already has a byte-optimizer, can't make it inline"
50 ;; x))
51 ;; (list 'put (list 'quote x)
52 ;; ''byte-optimizer ''byte-compile-inline-expand))
53 ;; fns)))
55 ;; (defmacro proclaim-notinline (&rest fns)
56 ;; "Cause the named functions to no longer be open-coded."
57 ;; (cons 'eval-and-compile
58 ;; (mapcar '(lambda (x)
59 ;; (if (eq (get x 'byte-optimizer) 'byte-compile-inline-expand)
60 ;; (put x 'byte-optimizer nil))
61 ;; (list 'if (list 'eq (list 'get (list 'quote x) ''byte-optimizer)
62 ;; ''byte-compile-inline-expand)
63 ;; (list 'put x ''byte-optimizer nil)))
64 ;; fns)))
66 ;; This has a special byte-hunk-handler in bytecomp.el.
67 (defmacro defsubst (name arglist &rest body)
68 "Define an inline function. The syntax is just like that of `defun'."
69 (or (memq (get name 'byte-optimizer)
70 '(nil byte-compile-inline-expand))
71 (error "`%s' is a primitive" name))
72 (list 'prog1
73 (cons 'defun (cons name (cons arglist body)))
74 (list 'eval-and-compile
75 (list 'put (list 'quote name)
76 ''byte-optimizer ''byte-compile-inline-expand))))
78 (defun make-obsolete (fn new)
79 "Make the byte-compiler warn that FUNCTION is obsolete.
80 The warning will say that NEW should be used instead.
81 If NEW is a string, that is the `use instead' message."
82 (interactive "aMake function obsolete: \nxObsoletion replacement: ")
83 (let ((handler (get fn 'byte-compile)))
84 (if (eq 'byte-compile-obsolete handler)
85 (setcar (get fn 'byte-obsolete-info) new)
86 (put fn 'byte-obsolete-info (cons new handler))
87 (put fn 'byte-compile 'byte-compile-obsolete)))
88 fn)
90 (put 'dont-compile 'lisp-indent-hook 0)
91 (defmacro dont-compile (&rest body)
92 "Like `progn', but the body always runs interpreted (not compiled)."
93 (list 'eval (list 'quote (if (cdr body) (cons 'progn body) (car body)))))
96 ;;; interface to evaluating things at compile time and/or load time
97 ;;; these macro must come after any uses of them in this file, as their
98 ;;; definition in the file overrides the magic definitions on the
99 ;;; byte-compile-macro-environment.
101 (put 'eval-when-compile 'lisp-indent-hook 0)
102 (defmacro eval-when-compile (&rest body)
103 "Like `progn', but evaluates the body at compile time.
104 The result of the body appears to the compiler as a quoted constant."
105 ;; Not necessary because we have it in b-c-initial-macro-environment
106 ;; (list 'quote (eval (cons 'progn body)))
107 (cons 'progn body))
109 (put 'eval-and-compile 'lisp-indent-hook 0)
110 (defmacro eval-and-compile (&rest body)
111 "Like `progn', but evaluates the body at compile time and at load time."
112 ;; Remember, it's magic.
113 (cons 'progn body))
116 ;;; I nuked this because it's not a good idea for users to think of using it.
117 ;;; These options are a matter of installation preference, and have nothing to
118 ;;; with particular source files; it's a mistake to suggest to users
119 ;;; they should associate these with particular source files.
120 ;;; There is hardly any reason to change these parameters, anyway.
121 ;;; --rms.
123 ;; (put 'byte-compiler-options 'lisp-indent-hook 0)
124 ;; (defmacro byte-compiler-options (&rest args)
125 ;; "Set some compilation-parameters for this file. This will affect only the
126 ;; file in which it appears; this does nothing when evaluated, and when loaded
127 ;; from a .el file.
129 ;; Each argument to this macro must be a list of a key and a value.
131 ;; Keys: Values: Corresponding variable:
133 ;; verbose t, nil byte-compile-verbose
134 ;; optimize t, nil, source, byte byte-compile-optimize
135 ;; warnings list of warnings byte-compile-warnings
136 ;; Legal elements: (callargs redefine free-vars unresolved)
137 ;; file-format emacs18, emacs19 byte-compile-compatibility
139 ;; For example, this might appear at the top of a source file:
141 ;; (byte-compiler-options
142 ;; (optimize t)
143 ;; (warnings (- free-vars)) ; Don't warn about free variables
144 ;; (file-format emacs19))"
145 ;; nil)
147 ;;; byte-run.el ends here