Mercurial > emacs
annotate lisp/emacs-lisp/byte-run.el @ 101406:6381c0548cdd
fix comments in last change
author | Adrian Robert <Adrian.B.Robert@gmail.com> |
---|---|
date | Fri, 23 Jan 2009 14:53:11 +0000 |
parents | a9dc0e7c3f2b |
children | 0299ec0f58e6 |
rev | line source |
---|---|
51349 | 1 ;;; byte-run.el --- byte-compiler support for inlining |
2 | |
74466 | 3 ;; Copyright (C) 1992, 2001, 2002, 2003, 2004, 2005, |
100908 | 4 ;; 2006, 2007, 2008, 2009 Free Software Foundation, Inc. |
51349 | 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 | |
94655
90a2847062be
Switch to recommended form of GPLv3 permissions notice.
Glenn Morris <rgm@gnu.org>
parents:
94023
diff
changeset
|
13 ;; GNU Emacs is free software: you can redistribute it and/or modify |
51349 | 14 ;; it under the terms of the GNU General Public License as published by |
94655
90a2847062be
Switch to recommended form of GPLv3 permissions notice.
Glenn Morris <rgm@gnu.org>
parents:
94023
diff
changeset
|
15 ;; the Free Software Foundation, either version 3 of the License, or |
90a2847062be
Switch to recommended form of GPLv3 permissions notice.
Glenn Morris <rgm@gnu.org>
parents:
94023
diff
changeset
|
16 ;; (at your option) any later version. |
51349 | 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 | |
94655
90a2847062be
Switch to recommended form of GPLv3 permissions notice.
Glenn Morris <rgm@gnu.org>
parents:
94023
diff
changeset
|
24 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. |
51349 | 25 |
26 ;;; Commentary: | |
27 | |
28 ;; interface to selectively inlining functions. | |
29 ;; This only happens when source-code optimization is turned on. | |
30 | |
31 ;;; Code: | |
32 | |
60597
e9f1d42f7fc0
(macro-declaration-function): Move from subr.el.
Lute Kamstra <lute@gnu.org>
parents:
60580
diff
changeset
|
33 ;; We define macro-declaration-function here because it is needed to |
e9f1d42f7fc0
(macro-declaration-function): Move from subr.el.
Lute Kamstra <lute@gnu.org>
parents:
60580
diff
changeset
|
34 ;; handle declarations in macro definitions and this is the first file |
e9f1d42f7fc0
(macro-declaration-function): Move from subr.el.
Lute Kamstra <lute@gnu.org>
parents:
60580
diff
changeset
|
35 ;; loaded by loadup.el that uses declarations in macros. |
e9f1d42f7fc0
(macro-declaration-function): Move from subr.el.
Lute Kamstra <lute@gnu.org>
parents:
60580
diff
changeset
|
36 |
e9f1d42f7fc0
(macro-declaration-function): Move from subr.el.
Lute Kamstra <lute@gnu.org>
parents:
60580
diff
changeset
|
37 (defun macro-declaration-function (macro decl) |
e9f1d42f7fc0
(macro-declaration-function): Move from subr.el.
Lute Kamstra <lute@gnu.org>
parents:
60580
diff
changeset
|
38 "Process a declaration found in a macro definition. |
e9f1d42f7fc0
(macro-declaration-function): Move from subr.el.
Lute Kamstra <lute@gnu.org>
parents:
60580
diff
changeset
|
39 This is set as the value of the variable `macro-declaration-function'. |
e9f1d42f7fc0
(macro-declaration-function): Move from subr.el.
Lute Kamstra <lute@gnu.org>
parents:
60580
diff
changeset
|
40 MACRO is the name of the macro being defined. |
e9f1d42f7fc0
(macro-declaration-function): Move from subr.el.
Lute Kamstra <lute@gnu.org>
parents:
60580
diff
changeset
|
41 DECL is a list `(declare ...)' containing the declarations. |
e9f1d42f7fc0
(macro-declaration-function): Move from subr.el.
Lute Kamstra <lute@gnu.org>
parents:
60580
diff
changeset
|
42 The return value of this function is not used." |
e9f1d42f7fc0
(macro-declaration-function): Move from subr.el.
Lute Kamstra <lute@gnu.org>
parents:
60580
diff
changeset
|
43 ;; We can't use `dolist' or `cadr' yet for bootstrapping reasons. |
e9f1d42f7fc0
(macro-declaration-function): Move from subr.el.
Lute Kamstra <lute@gnu.org>
parents:
60580
diff
changeset
|
44 (let (d) |
e9f1d42f7fc0
(macro-declaration-function): Move from subr.el.
Lute Kamstra <lute@gnu.org>
parents:
60580
diff
changeset
|
45 ;; Ignore the first element of `decl' (it's always `declare'). |
e9f1d42f7fc0
(macro-declaration-function): Move from subr.el.
Lute Kamstra <lute@gnu.org>
parents:
60580
diff
changeset
|
46 (while (setq decl (cdr decl)) |
e9f1d42f7fc0
(macro-declaration-function): Move from subr.el.
Lute Kamstra <lute@gnu.org>
parents:
60580
diff
changeset
|
47 (setq d (car decl)) |
100064
b42d22c5897f
(macro-declaration-function): Disallow declare specs with lengths of 3
Chong Yidong <cyd@stupidchicken.com>
parents:
94655
diff
changeset
|
48 (if (and (consp d) |
b42d22c5897f
(macro-declaration-function): Disallow declare specs with lengths of 3
Chong Yidong <cyd@stupidchicken.com>
parents:
94655
diff
changeset
|
49 (listp (cdr d)) |
b42d22c5897f
(macro-declaration-function): Disallow declare specs with lengths of 3
Chong Yidong <cyd@stupidchicken.com>
parents:
94655
diff
changeset
|
50 (null (cdr (cdr d)))) |
b42d22c5897f
(macro-declaration-function): Disallow declare specs with lengths of 3
Chong Yidong <cyd@stupidchicken.com>
parents:
94655
diff
changeset
|
51 (cond ((eq (car d) 'indent) |
b42d22c5897f
(macro-declaration-function): Disallow declare specs with lengths of 3
Chong Yidong <cyd@stupidchicken.com>
parents:
94655
diff
changeset
|
52 (put macro 'lisp-indent-function (car (cdr d)))) |
b42d22c5897f
(macro-declaration-function): Disallow declare specs with lengths of 3
Chong Yidong <cyd@stupidchicken.com>
parents:
94655
diff
changeset
|
53 ((eq (car d) 'debug) |
b42d22c5897f
(macro-declaration-function): Disallow declare specs with lengths of 3
Chong Yidong <cyd@stupidchicken.com>
parents:
94655
diff
changeset
|
54 (put macro 'edebug-form-spec (car (cdr d)))) |
b42d22c5897f
(macro-declaration-function): Disallow declare specs with lengths of 3
Chong Yidong <cyd@stupidchicken.com>
parents:
94655
diff
changeset
|
55 ((eq (car d) 'doc-string) |
b42d22c5897f
(macro-declaration-function): Disallow declare specs with lengths of 3
Chong Yidong <cyd@stupidchicken.com>
parents:
94655
diff
changeset
|
56 (put macro 'doc-string-elt (car (cdr d)))) |
b42d22c5897f
(macro-declaration-function): Disallow declare specs with lengths of 3
Chong Yidong <cyd@stupidchicken.com>
parents:
94655
diff
changeset
|
57 (t |
b42d22c5897f
(macro-declaration-function): Disallow declare specs with lengths of 3
Chong Yidong <cyd@stupidchicken.com>
parents:
94655
diff
changeset
|
58 (message "Unknown declaration %s" d))) |
b42d22c5897f
(macro-declaration-function): Disallow declare specs with lengths of 3
Chong Yidong <cyd@stupidchicken.com>
parents:
94655
diff
changeset
|
59 (message "Invalid declaration %s" d))))) |
b42d22c5897f
(macro-declaration-function): Disallow declare specs with lengths of 3
Chong Yidong <cyd@stupidchicken.com>
parents:
94655
diff
changeset
|
60 |
60597
e9f1d42f7fc0
(macro-declaration-function): Move from subr.el.
Lute Kamstra <lute@gnu.org>
parents:
60580
diff
changeset
|
61 |
e9f1d42f7fc0
(macro-declaration-function): Move from subr.el.
Lute Kamstra <lute@gnu.org>
parents:
60580
diff
changeset
|
62 (setq macro-declaration-function 'macro-declaration-function) |
e9f1d42f7fc0
(macro-declaration-function): Move from subr.el.
Lute Kamstra <lute@gnu.org>
parents:
60580
diff
changeset
|
63 |
e9f1d42f7fc0
(macro-declaration-function): Move from subr.el.
Lute Kamstra <lute@gnu.org>
parents:
60580
diff
changeset
|
64 |
51349 | 65 ;; Redefined in byte-optimize.el. |
66 ;; This is not documented--it's not clear that we should promote it. | |
67 (fset 'inline 'progn) | |
60580
a7bed417c2e6
Replace lisp-indent-hook with lisp-indent-function throughout.
Lute Kamstra <lute@gnu.org>
parents:
55405
diff
changeset
|
68 (put 'inline 'lisp-indent-function 0) |
51349 | 69 |
70 ;;; Interface to inline functions. | |
71 | |
72 ;; (defmacro proclaim-inline (&rest fns) | |
73 ;; "Cause the named functions to be open-coded when called from compiled code. | |
74 ;; They will only be compiled open-coded when byte-compile-optimize is true." | |
75 ;; (cons 'eval-and-compile | |
76 ;; (mapcar '(lambda (x) | |
77 ;; (or (memq (get x 'byte-optimizer) | |
78 ;; '(nil byte-compile-inline-expand)) | |
79 ;; (error | |
80 ;; "%s already has a byte-optimizer, can't make it inline" | |
81 ;; x)) | |
82 ;; (list 'put (list 'quote x) | |
83 ;; ''byte-optimizer ''byte-compile-inline-expand)) | |
84 ;; fns))) | |
85 | |
86 ;; (defmacro proclaim-notinline (&rest fns) | |
87 ;; "Cause the named functions to no longer be open-coded." | |
88 ;; (cons 'eval-and-compile | |
89 ;; (mapcar '(lambda (x) | |
90 ;; (if (eq (get x 'byte-optimizer) 'byte-compile-inline-expand) | |
91 ;; (put x 'byte-optimizer nil)) | |
92 ;; (list 'if (list 'eq (list 'get (list 'quote x) ''byte-optimizer) | |
93 ;; ''byte-compile-inline-expand) | |
94 ;; (list 'put x ''byte-optimizer nil))) | |
95 ;; fns))) | |
96 | |
97 ;; This has a special byte-hunk-handler in bytecomp.el. | |
98 (defmacro defsubst (name arglist &rest body) | |
99 "Define an inline function. The syntax is just like that of `defun'." | |
54496
94bcfb39cf49
(defsubst): Add edebug spec and use backquote.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
54413
diff
changeset
|
100 (declare (debug defun)) |
51349 | 101 (or (memq (get name 'byte-optimizer) |
102 '(nil byte-compile-inline-expand)) | |
103 (error "`%s' is a primitive" name)) | |
54496
94bcfb39cf49
(defsubst): Add edebug spec and use backquote.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
54413
diff
changeset
|
104 `(prog1 |
94bcfb39cf49
(defsubst): Add edebug spec and use backquote.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
54413
diff
changeset
|
105 (defun ,name ,arglist ,@body) |
94bcfb39cf49
(defsubst): Add edebug spec and use backquote.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
54413
diff
changeset
|
106 (eval-and-compile |
94bcfb39cf49
(defsubst): Add edebug spec and use backquote.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
54413
diff
changeset
|
107 (put ',name 'byte-optimizer 'byte-compile-inline-expand)))) |
51349 | 108 |
63435
a5ba219acb16
(make-obsolete, define-obsolete-function-alias): Rename arguments FUNCTION and
Juanma Barranquero <lekktu@gmail.com>
parents:
62520
diff
changeset
|
109 (defun make-obsolete (obsolete-name current-name &optional when) |
a5ba219acb16
(make-obsolete, define-obsolete-function-alias): Rename arguments FUNCTION and
Juanma Barranquero <lekktu@gmail.com>
parents:
62520
diff
changeset
|
110 "Make the byte-compiler warn that OBSOLETE-NAME is obsolete. |
a5ba219acb16
(make-obsolete, define-obsolete-function-alias): Rename arguments FUNCTION and
Juanma Barranquero <lekktu@gmail.com>
parents:
62520
diff
changeset
|
111 The warning will say that CURRENT-NAME should be used instead. |
92295 | 112 If CURRENT-NAME is a string, that is the `use instead' message |
113 \(it should end with a period, and not start with a capital). | |
51349 | 114 If provided, WHEN should be a string indicating when the function |
115 was first made obsolete, for example a date or a release number." | |
116 (interactive "aMake function obsolete: \nxObsoletion replacement: ") | |
63435
a5ba219acb16
(make-obsolete, define-obsolete-function-alias): Rename arguments FUNCTION and
Juanma Barranquero <lekktu@gmail.com>
parents:
62520
diff
changeset
|
117 (let ((handler (get obsolete-name 'byte-compile))) |
51349 | 118 (if (eq 'byte-compile-obsolete handler) |
63435
a5ba219acb16
(make-obsolete, define-obsolete-function-alias): Rename arguments FUNCTION and
Juanma Barranquero <lekktu@gmail.com>
parents:
62520
diff
changeset
|
119 (setq handler (nth 1 (get obsolete-name 'byte-obsolete-info))) |
a5ba219acb16
(make-obsolete, define-obsolete-function-alias): Rename arguments FUNCTION and
Juanma Barranquero <lekktu@gmail.com>
parents:
62520
diff
changeset
|
120 (put obsolete-name 'byte-compile 'byte-compile-obsolete)) |
a5ba219acb16
(make-obsolete, define-obsolete-function-alias): Rename arguments FUNCTION and
Juanma Barranquero <lekktu@gmail.com>
parents:
62520
diff
changeset
|
121 (put obsolete-name 'byte-obsolete-info (list current-name handler when))) |
a5ba219acb16
(make-obsolete, define-obsolete-function-alias): Rename arguments FUNCTION and
Juanma Barranquero <lekktu@gmail.com>
parents:
62520
diff
changeset
|
122 obsolete-name) |
51349 | 123 |
63435
a5ba219acb16
(make-obsolete, define-obsolete-function-alias): Rename arguments FUNCTION and
Juanma Barranquero <lekktu@gmail.com>
parents:
62520
diff
changeset
|
124 (defmacro define-obsolete-function-alias (obsolete-name current-name |
61843
a158628ce6ac
(define-obsolete-function-alias): New macro.
Nick Roberts <nickrob@snap.net.nz>
parents:
61730
diff
changeset
|
125 &optional when docstring) |
63435
a5ba219acb16
(make-obsolete, define-obsolete-function-alias): Rename arguments FUNCTION and
Juanma Barranquero <lekktu@gmail.com>
parents:
62520
diff
changeset
|
126 "Set OBSOLETE-NAME's function definition to CURRENT-NAME and mark it obsolete. |
62094
ba1ec4834766
(define-obsolete-function-alias, define-obsolete-variable-alias): Doc Fixes.
Luc Teirlinck <teirllm@auburn.edu>
parents:
62072
diff
changeset
|
127 |
ba1ec4834766
(define-obsolete-function-alias, define-obsolete-variable-alias): Doc Fixes.
Luc Teirlinck <teirllm@auburn.edu>
parents:
62072
diff
changeset
|
128 \(define-obsolete-function-alias 'old-fun 'new-fun \"22.1\" \"old-fun's doc.\") |
ba1ec4834766
(define-obsolete-function-alias, define-obsolete-variable-alias): Doc Fixes.
Luc Teirlinck <teirllm@auburn.edu>
parents:
62072
diff
changeset
|
129 |
ba1ec4834766
(define-obsolete-function-alias, define-obsolete-variable-alias): Doc Fixes.
Luc Teirlinck <teirllm@auburn.edu>
parents:
62072
diff
changeset
|
130 is equivalent to the following two lines of code: |
ba1ec4834766
(define-obsolete-function-alias, define-obsolete-variable-alias): Doc Fixes.
Luc Teirlinck <teirllm@auburn.edu>
parents:
62072
diff
changeset
|
131 |
ba1ec4834766
(define-obsolete-function-alias, define-obsolete-variable-alias): Doc Fixes.
Luc Teirlinck <teirllm@auburn.edu>
parents:
62072
diff
changeset
|
132 \(defalias 'old-fun 'new-fun \"old-fun's doc.\") |
ba1ec4834766
(define-obsolete-function-alias, define-obsolete-variable-alias): Doc Fixes.
Luc Teirlinck <teirllm@auburn.edu>
parents:
62072
diff
changeset
|
133 \(make-obsolete 'old-fun 'new-fun \"22.1\") |
ba1ec4834766
(define-obsolete-function-alias, define-obsolete-variable-alias): Doc Fixes.
Luc Teirlinck <teirllm@auburn.edu>
parents:
62072
diff
changeset
|
134 |
ba1ec4834766
(define-obsolete-function-alias, define-obsolete-variable-alias): Doc Fixes.
Luc Teirlinck <teirllm@auburn.edu>
parents:
62072
diff
changeset
|
135 See the docstrings of `defalias' and `make-obsolete' for more details." |
66403
6d02f0b72652
(define-obsolete-function-alias, define-obsolete-variable-alias):
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
66397
diff
changeset
|
136 (declare (doc-string 4)) |
61843
a158628ce6ac
(define-obsolete-function-alias): New macro.
Nick Roberts <nickrob@snap.net.nz>
parents:
61730
diff
changeset
|
137 `(progn |
63435
a5ba219acb16
(make-obsolete, define-obsolete-function-alias): Rename arguments FUNCTION and
Juanma Barranquero <lekktu@gmail.com>
parents:
62520
diff
changeset
|
138 (defalias ,obsolete-name ,current-name ,docstring) |
a5ba219acb16
(make-obsolete, define-obsolete-function-alias): Rename arguments FUNCTION and
Juanma Barranquero <lekktu@gmail.com>
parents:
62520
diff
changeset
|
139 (make-obsolete ,obsolete-name ,current-name ,when))) |
61843
a158628ce6ac
(define-obsolete-function-alias): New macro.
Nick Roberts <nickrob@snap.net.nz>
parents:
61730
diff
changeset
|
140 |
63435
a5ba219acb16
(make-obsolete, define-obsolete-function-alias): Rename arguments FUNCTION and
Juanma Barranquero <lekktu@gmail.com>
parents:
62520
diff
changeset
|
141 (defun make-obsolete-variable (obsolete-name current-name &optional when) |
a5ba219acb16
(make-obsolete, define-obsolete-function-alias): Rename arguments FUNCTION and
Juanma Barranquero <lekktu@gmail.com>
parents:
62520
diff
changeset
|
142 "Make the byte-compiler warn that OBSOLETE-NAME is obsolete. |
a5ba219acb16
(make-obsolete, define-obsolete-function-alias): Rename arguments FUNCTION and
Juanma Barranquero <lekktu@gmail.com>
parents:
62520
diff
changeset
|
143 The warning will say that CURRENT-NAME should be used instead. |
a5ba219acb16
(make-obsolete, define-obsolete-function-alias): Rename arguments FUNCTION and
Juanma Barranquero <lekktu@gmail.com>
parents:
62520
diff
changeset
|
144 If CURRENT-NAME is a string, that is the `use instead' message. |
51349 | 145 If provided, WHEN should be a string indicating when the variable |
146 was first made obsolete, for example a date or a release number." | |
147 (interactive | |
148 (list | |
149 (let ((str (completing-read "Make variable obsolete: " obarray 'boundp t))) | |
150 (if (equal str "") (error "")) | |
151 (intern str)) | |
152 (car (read-from-string (read-string "Obsoletion replacement: "))))) | |
63435
a5ba219acb16
(make-obsolete, define-obsolete-function-alias): Rename arguments FUNCTION and
Juanma Barranquero <lekktu@gmail.com>
parents:
62520
diff
changeset
|
153 (put obsolete-name 'byte-obsolete-variable (cons current-name when)) |
a5ba219acb16
(make-obsolete, define-obsolete-function-alias): Rename arguments FUNCTION and
Juanma Barranquero <lekktu@gmail.com>
parents:
62520
diff
changeset
|
154 obsolete-name) |
51349 | 155 |
63435
a5ba219acb16
(make-obsolete, define-obsolete-function-alias): Rename arguments FUNCTION and
Juanma Barranquero <lekktu@gmail.com>
parents:
62520
diff
changeset
|
156 (defmacro define-obsolete-variable-alias (obsolete-name current-name |
61730
d4e4e1694bf8
(define-obsolete-variable-alias): New macro.
Nick Roberts <nickrob@snap.net.nz>
parents:
60597
diff
changeset
|
157 &optional when docstring) |
63435
a5ba219acb16
(make-obsolete, define-obsolete-function-alias): Rename arguments FUNCTION and
Juanma Barranquero <lekktu@gmail.com>
parents:
62520
diff
changeset
|
158 "Make OBSOLETE-NAME a variable alias for CURRENT-NAME and mark it obsolete. |
62094
ba1ec4834766
(define-obsolete-function-alias, define-obsolete-variable-alias): Doc Fixes.
Luc Teirlinck <teirllm@auburn.edu>
parents:
62072
diff
changeset
|
159 |
ba1ec4834766
(define-obsolete-function-alias, define-obsolete-variable-alias): Doc Fixes.
Luc Teirlinck <teirllm@auburn.edu>
parents:
62072
diff
changeset
|
160 \(define-obsolete-variable-alias 'old-var 'new-var \"22.1\" \"old-var's doc.\") |
ba1ec4834766
(define-obsolete-function-alias, define-obsolete-variable-alias): Doc Fixes.
Luc Teirlinck <teirllm@auburn.edu>
parents:
62072
diff
changeset
|
161 |
ba1ec4834766
(define-obsolete-function-alias, define-obsolete-variable-alias): Doc Fixes.
Luc Teirlinck <teirllm@auburn.edu>
parents:
62072
diff
changeset
|
162 is equivalent to the following two lines of code: |
ba1ec4834766
(define-obsolete-function-alias, define-obsolete-variable-alias): Doc Fixes.
Luc Teirlinck <teirllm@auburn.edu>
parents:
62072
diff
changeset
|
163 |
ba1ec4834766
(define-obsolete-function-alias, define-obsolete-variable-alias): Doc Fixes.
Luc Teirlinck <teirllm@auburn.edu>
parents:
62072
diff
changeset
|
164 \(defvaralias 'old-var 'new-var \"old-var's doc.\") |
ba1ec4834766
(define-obsolete-function-alias, define-obsolete-variable-alias): Doc Fixes.
Luc Teirlinck <teirllm@auburn.edu>
parents:
62072
diff
changeset
|
165 \(make-obsolete-variable 'old-var 'new-var \"22.1\") |
ba1ec4834766
(define-obsolete-function-alias, define-obsolete-variable-alias): Doc Fixes.
Luc Teirlinck <teirllm@auburn.edu>
parents:
62072
diff
changeset
|
166 |
94023
1841ac94b011
(define-obsolete-variable-alias): Doc fix.
Glenn Morris <rgm@gnu.org>
parents:
92295
diff
changeset
|
167 If CURRENT-NAME is a defcustom (more generally, any variable |
1841ac94b011
(define-obsolete-variable-alias): Doc fix.
Glenn Morris <rgm@gnu.org>
parents:
92295
diff
changeset
|
168 where OBSOLETE-NAME may be set, e.g. in a .emacs file, before the |
1841ac94b011
(define-obsolete-variable-alias): Doc fix.
Glenn Morris <rgm@gnu.org>
parents:
92295
diff
changeset
|
169 alias is defined), then the define-obsolete-variable-alias |
1841ac94b011
(define-obsolete-variable-alias): Doc fix.
Glenn Morris <rgm@gnu.org>
parents:
92295
diff
changeset
|
170 statement should be placed before the defcustom. This is so that |
1841ac94b011
(define-obsolete-variable-alias): Doc fix.
Glenn Morris <rgm@gnu.org>
parents:
92295
diff
changeset
|
171 any user customizations are applied before the defcustom tries to |
1841ac94b011
(define-obsolete-variable-alias): Doc fix.
Glenn Morris <rgm@gnu.org>
parents:
92295
diff
changeset
|
172 initialize the variable (this is due to the way `defvaralias' works). |
1841ac94b011
(define-obsolete-variable-alias): Doc fix.
Glenn Morris <rgm@gnu.org>
parents:
92295
diff
changeset
|
173 Exceptions to this rule occur for define-obsolete-variable-alias |
1841ac94b011
(define-obsolete-variable-alias): Doc fix.
Glenn Morris <rgm@gnu.org>
parents:
92295
diff
changeset
|
174 statements that are autoloaded, or in files dumped with Emacs. |
1841ac94b011
(define-obsolete-variable-alias): Doc fix.
Glenn Morris <rgm@gnu.org>
parents:
92295
diff
changeset
|
175 |
62094
ba1ec4834766
(define-obsolete-function-alias, define-obsolete-variable-alias): Doc Fixes.
Luc Teirlinck <teirllm@auburn.edu>
parents:
62072
diff
changeset
|
176 See the docstrings of `defvaralias' and `make-obsolete-variable' or |
ba1ec4834766
(define-obsolete-function-alias, define-obsolete-variable-alias): Doc Fixes.
Luc Teirlinck <teirllm@auburn.edu>
parents:
62072
diff
changeset
|
177 Info node `(elisp)Variable Aliases' for more details." |
66403
6d02f0b72652
(define-obsolete-function-alias, define-obsolete-variable-alias):
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
66397
diff
changeset
|
178 (declare (doc-string 4)) |
61730
d4e4e1694bf8
(define-obsolete-variable-alias): New macro.
Nick Roberts <nickrob@snap.net.nz>
parents:
60597
diff
changeset
|
179 `(progn |
63435
a5ba219acb16
(make-obsolete, define-obsolete-function-alias): Rename arguments FUNCTION and
Juanma Barranquero <lekktu@gmail.com>
parents:
62520
diff
changeset
|
180 (defvaralias ,obsolete-name ,current-name ,docstring) |
66403
6d02f0b72652
(define-obsolete-function-alias, define-obsolete-variable-alias):
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
66397
diff
changeset
|
181 (make-obsolete-variable ,obsolete-name ,current-name ,when))) |
61730
d4e4e1694bf8
(define-obsolete-variable-alias): New macro.
Nick Roberts <nickrob@snap.net.nz>
parents:
60597
diff
changeset
|
182 |
51349 | 183 (defmacro dont-compile (&rest body) |
184 "Like `progn', but the body always runs interpreted (not compiled). | |
185 If you think you need this, you're probably making a mistake somewhere." | |
60597
e9f1d42f7fc0
(macro-declaration-function): Move from subr.el.
Lute Kamstra <lute@gnu.org>
parents:
60580
diff
changeset
|
186 (declare (debug t) (indent 0)) |
51349 | 187 (list 'eval (list 'quote (if (cdr body) (cons 'progn body) (car body))))) |
188 | |
189 | |
66403
6d02f0b72652
(define-obsolete-function-alias, define-obsolete-variable-alias):
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
66397
diff
changeset
|
190 ;; interface to evaluating things at compile time and/or load time |
6d02f0b72652
(define-obsolete-function-alias, define-obsolete-variable-alias):
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
66397
diff
changeset
|
191 ;; these macro must come after any uses of them in this file, as their |
6d02f0b72652
(define-obsolete-function-alias, define-obsolete-variable-alias):
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
66397
diff
changeset
|
192 ;; definition in the file overrides the magic definitions on the |
6d02f0b72652
(define-obsolete-function-alias, define-obsolete-variable-alias):
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
66397
diff
changeset
|
193 ;; byte-compile-macro-environment. |
51349 | 194 |
195 (defmacro eval-when-compile (&rest body) | |
62520
ee08cd4e1bf0
(eval-when-compile): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents:
62094
diff
changeset
|
196 "Like `progn', but evaluates the body at compile time if you're compiling. |
ee08cd4e1bf0
(eval-when-compile): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents:
62094
diff
changeset
|
197 Thus, the result of the body appears to the compiler as a quoted constant. |
ee08cd4e1bf0
(eval-when-compile): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents:
62094
diff
changeset
|
198 In interpreted code, this is entirely equivalent to `progn'." |
60597
e9f1d42f7fc0
(macro-declaration-function): Move from subr.el.
Lute Kamstra <lute@gnu.org>
parents:
60580
diff
changeset
|
199 (declare (debug t) (indent 0)) |
51349 | 200 ;; Not necessary because we have it in b-c-initial-macro-environment |
201 ;; (list 'quote (eval (cons 'progn body))) | |
202 (cons 'progn body)) | |
203 | |
204 (defmacro eval-and-compile (&rest body) | |
205 "Like `progn', but evaluates the body at compile time and at load time." | |
60597
e9f1d42f7fc0
(macro-declaration-function): Move from subr.el.
Lute Kamstra <lute@gnu.org>
parents:
60580
diff
changeset
|
206 (declare (debug t) (indent 0)) |
51349 | 207 ;; Remember, it's magic. |
208 (cons 'progn body)) | |
209 | |
60580
a7bed417c2e6
Replace lisp-indent-hook with lisp-indent-function throughout.
Lute Kamstra <lute@gnu.org>
parents:
55405
diff
changeset
|
210 (put 'with-no-warnings 'lisp-indent-function 0) |
55041
1376729a93a7
(with-no-warnings): Simplify: take all args as &rest arg.
Richard M. Stallman <rms@gnu.org>
parents:
54496
diff
changeset
|
211 (defun with-no-warnings (&rest body) |
51349 | 212 "Like `progn', but prevents compiler warnings in the body." |
213 ;; The implementation for the interpreter is basically trivial. | |
55041
1376729a93a7
(with-no-warnings): Simplify: take all args as &rest arg.
Richard M. Stallman <rms@gnu.org>
parents:
54496
diff
changeset
|
214 (car (last body))) |
51349 | 215 |
216 | |
66403
6d02f0b72652
(define-obsolete-function-alias, define-obsolete-variable-alias):
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
66397
diff
changeset
|
217 ;; I nuked this because it's not a good idea for users to think of using it. |
6d02f0b72652
(define-obsolete-function-alias, define-obsolete-variable-alias):
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
66397
diff
changeset
|
218 ;; These options are a matter of installation preference, and have nothing to |
6d02f0b72652
(define-obsolete-function-alias, define-obsolete-variable-alias):
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
66397
diff
changeset
|
219 ;; with particular source files; it's a mistake to suggest to users |
6d02f0b72652
(define-obsolete-function-alias, define-obsolete-variable-alias):
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
66397
diff
changeset
|
220 ;; they should associate these with particular source files. |
6d02f0b72652
(define-obsolete-function-alias, define-obsolete-variable-alias):
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
66397
diff
changeset
|
221 ;; There is hardly any reason to change these parameters, anyway. |
6d02f0b72652
(define-obsolete-function-alias, define-obsolete-variable-alias):
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
66397
diff
changeset
|
222 ;; --rms. |
51349 | 223 |
60580
a7bed417c2e6
Replace lisp-indent-hook with lisp-indent-function throughout.
Lute Kamstra <lute@gnu.org>
parents:
55405
diff
changeset
|
224 ;; (put 'byte-compiler-options 'lisp-indent-function 0) |
51349 | 225 ;; (defmacro byte-compiler-options (&rest args) |
226 ;; "Set some compilation-parameters for this file. This will affect only the | |
227 ;; file in which it appears; this does nothing when evaluated, and when loaded | |
228 ;; from a .el file. | |
229 ;; | |
230 ;; Each argument to this macro must be a list of a key and a value. | |
231 ;; | |
232 ;; Keys: Values: Corresponding variable: | |
233 ;; | |
234 ;; verbose t, nil byte-compile-verbose | |
235 ;; optimize t, nil, source, byte byte-compile-optimize | |
236 ;; warnings list of warnings byte-compile-warnings | |
80040
c86cce8752cb
*** empty log message ***
Juanma Barranquero <lekktu@gmail.com>
parents:
79704
diff
changeset
|
237 ;; Valid elements: (callargs redefine free-vars unresolved) |
51349 | 238 ;; file-format emacs18, emacs19 byte-compile-compatibility |
239 ;; | |
240 ;; For example, this might appear at the top of a source file: | |
241 ;; | |
242 ;; (byte-compiler-options | |
243 ;; (optimize t) | |
244 ;; (warnings (- free-vars)) ; Don't warn about free variables | |
245 ;; (file-format emacs19))" | |
246 ;; nil) | |
247 | |
66403
6d02f0b72652
(define-obsolete-function-alias, define-obsolete-variable-alias):
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
66397
diff
changeset
|
248 ;; arch-tag: 76f8328a-1f66-4df2-9b6d-5c3666dc05e9 |
51349 | 249 ;;; byte-run.el ends here |