1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
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
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
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
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
|
;;; pym.el --- Macros for Your Poe -*- lexical-binding: t -*-
;; Copyright (C) 1995,1996,1997,1998,1999 Free Software Foundation, Inc.
;; Author: MORIOKA Tomohiko <tomo@m17n.org>
;; Shuhei KOBAYASHI <shuhei@aqua.ocn.ne.jp>
;; Keywords: byte-compile, evaluation, edebug, internal
;; This file is part of APEL (A Portable Emacs Library).
;; This program is free software; you can redistribute it and/or
;; modify it under the terms of the GNU General Public License as
;; published by the Free Software Foundation; either version 2, or (at
;; your option) any later version.
;; This program 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
;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
;; Boston, MA 02110-1301, USA.
;;; Commentary:
;; This module provides `def*-maybe' macros for conditional definition.
;;
;; Many APEL modules use these macros to provide the emulating version
;; of the Emacs builtins (both C primitives and lisp subroutines) for
;; backward compatibility. While compilation time, if `def*-maybe'
;; find that functions/variables being defined is already provided by
;; Emacs used for compilation, it does not leave the definitions in
;; compiled code and resulting .elc files will be highly specialized
;; for your environment. Lisp programmers should be aware that these
;; macros will never provide functions or variables at run-time if they
;; are defined for some reason (or by accident) at compilation time.
;; For `find-function' lovers, the following definitions may work with
;; `def*-maybe'.
;;
;; (setq find-function-regexp
;; "^\\s-*(def[^cgvW]\\(\\w\\|-\\)+\\*?\\s-+'?%s\\(\\s-\\|$\\)")
;; (setq find-variable-regexp
;; "^\\s-*(def[^umaW]\\(\\w\\|-\\)+\\*?\\s-+%s\\(\\s-\\|$\\)")
;;
;; I'm too lazy to write better regexps, sorry. -- shuhei
;;; Code:
;; for `load-history'.
(or (boundp 'current-load-list) (setq current-load-list nil))
(require 'static)
;;; Conditional define.
(put 'defun-maybe 'lisp-indent-function 'defun)
(defmacro defun-maybe (name &rest everything-else)
"Define NAME as a function if NAME is not defined.
See also the function `defun'."
(or (and (fboundp name)
(not (get name 'defun-maybe)))
`(or (fboundp (quote ,name))
(prog1
(defun ,name ,@ everything-else)
;; This `defun' will be compiled to `fset',
;; which does not update `load-history'.
;; We must update `current-load-list' explicitly.
(setq current-load-list
(cons (quote ,name) current-load-list))
(put (quote ,name) 'defun-maybe t)))))
(put 'defmacro-maybe 'lisp-indent-function 'defun)
(defmacro defmacro-maybe (name &rest everything-else)
"Define NAME as a macro if NAME is not defined.
See also the function `defmacro'."
(or (and (fboundp name)
(not (get name 'defmacro-maybe)))
`(or (fboundp (quote ,name))
(prog1
(defmacro ,name ,@ everything-else)
;; This `defmacro' will be compiled to `fset',
;; which does not update `load-history'.
;; We must update `current-load-list' explicitly.
(setq current-load-list
(cons (quote ,name) current-load-list))
(put (quote ,name) 'defmacro-maybe t)))))
(put 'defsubst-maybe 'lisp-indent-function 'defun)
(defmacro defsubst-maybe (name &rest everything-else)
"Define NAME as an inline function if NAME is not defined.
See also the macro `defsubst'."
(or (and (fboundp name)
(not (get name 'defsubst-maybe)))
`(or (fboundp (quote ,name))
(prog1
(defsubst ,name ,@ everything-else)
;; This `defsubst' will be compiled to `fset',
;; which does not update `load-history'.
;; We must update `current-load-list' explicitly.
(setq current-load-list
(cons (quote ,name) current-load-list))
(put (quote ,name) 'defsubst-maybe t)))))
(defmacro defalias-maybe (symbol definition)
"Define SYMBOL as an alias for DEFINITION if SYMBOL is not defined.
See also the function `defalias'."
(setq symbol (eval symbol))
(or (and (fboundp symbol)
(not (get symbol 'defalias-maybe)))
`(or (fboundp (quote ,symbol))
(prog1
(defalias (quote ,symbol) ,definition)
;; `defalias' updates `load-history' internally.
(put (quote ,symbol) 'defalias-maybe t)))))
(defmacro defvar-maybe (name &rest everything-else)
"Define NAME as a variable if NAME is not defined.
See also the function `defvar'."
(or (and (boundp name)
(not (get name 'defvar-maybe)))
`(or (boundp (quote ,name))
(prog1
(defvar ,name ,@ everything-else)
;; byte-compiler will generate code to update
;; `load-history'.
(put (quote ,name) 'defvar-maybe t)))))
(defmacro defconst-maybe (name &rest everything-else)
"Define NAME as a constant variable if NAME is not defined.
See also the function `defconst'."
(or (and (boundp name)
(not (get name 'defconst-maybe)))
`(or (boundp (quote ,name))
(prog1
(defconst ,name ,@ everything-else)
;; byte-compiler will generate code to update
;; `load-history'.
(put (quote ,name) 'defconst-maybe t)))))
(defmacro defun-maybe-cond (name args &optional doc &rest clauses)
"Define NAME as a function if NAME is not defined.
CLAUSES are like those of `cond' expression, but each condition is evaluated
at compile-time and, if the value is non-nil, the body of the clause is used
for function definition of NAME.
See also the function `defun'."
(or (stringp doc)
(setq clauses (cons doc clauses)
doc nil))
(or (and (fboundp name)
(not (get name 'defun-maybe)))
`(or (fboundp (quote ,name))
(prog1
(static-cond
,@ (mapcar
(lambda (case)
(list (car case)
(if doc
`(defun ,name ,args
,doc
,@ (cdr case))
` (defun ,name ,args
,@ (cdr case)))))
clauses))
;; This `defun' will be compiled to `fset',
;; which does not update `load-history'.
;; We must update `current-load-list' explicitly.
(setq current-load-list
(cons (quote ,name) current-load-list))
(put (quote ,name) 'defun-maybe t)))))
(defmacro defmacro-maybe-cond (name args &optional doc &rest clauses)
"Define NAME as a macro if NAME is not defined.
CLAUSES are like those of `cond' expression, but each condition is evaluated
at compile-time and, if the value is non-nil, the body of the clause is used
for macro definition of NAME.
See also the function `defmacro'."
(or (stringp doc)
(setq clauses (cons doc clauses)
doc nil))
(or (and (fboundp name)
(not (get name 'defmacro-maybe)))
`(or (fboundp (quote ,name))
(prog1
(static-cond
,@ (mapcar
(lambda (case)
(list (car case)
(if doc
`(defmacro ,name ,args
,doc
,@ (cdr case))
`(defmacro ,name ,args
,@ (cdr case)))))
clauses))
;; This `defmacro' will be compiled to `fset',
;; which does not update `load-history'.
;; We must update `current-load-list' explicitly.
(setq current-load-list
(cons (quote ,name) current-load-list))
(put (quote ,name) 'defmacro-maybe t)))))
(defmacro defsubst-maybe-cond (name args &optional doc &rest clauses)
"Define NAME as an inline function if NAME is not defined.
CLAUSES are like those of `cond' expression, but each condition is evaluated
at compile-time and, if the value is non-nil, the body of the clause is used
for function definition of NAME.
See also the macro `defsubst'."
(or (stringp doc)
(setq clauses (cons doc clauses)
doc nil))
(or (and (fboundp name)
(not (get name 'defsubst-maybe)))
`(or (fboundp (quote ,name))
(prog1
(static-cond
,@ (mapcar
(lambda (case)
(list (car case)
(if doc
`(defsubst ,name ,args
,doc
,@ (cdr case))
`(defsubst ,name ,args
,@ (cdr case)))))
clauses))
;; This `defsubst' will be compiled to `fset',
;; which does not update `load-history'.
;; We must update `current-load-list' explicitly.
(setq current-load-list
(cons (quote ,name) current-load-list))
(put (quote ,name) 'defsubst-maybe t)))))
;;; Edebug spec.
;; `def-edebug-spec' is an autoloaded macro in v19 and later.
;; (Note that recent XEmacs provides "edebug" as a separate package.)
(defmacro-maybe def-edebug-spec (symbol spec)
"Set the edebug-form-spec property of SYMBOL according to SPEC.
Both SYMBOL and SPEC are unevaluated. The SPEC can be 0, t, a symbol
\(naming a function\), or a list."
`(put (quote ,symbol) 'edebug-form-spec (quote ,spec)))
;; edebug-spec for `def*-maybe' macros.
(def-edebug-spec defun-maybe defun)
(def-edebug-spec defmacro-maybe defmacro)
(def-edebug-spec defsubst-maybe defun)
(def-edebug-spec defun-maybe-cond
(&define name lambda-list
[&optional stringp]
[&rest ([¬ eval] [&rest sexp])]
[&optional (eval [&optional ("interactive" interactive)] def-body)]
&rest (&rest sexp)))
(def-edebug-spec defmacro-maybe-cond
(&define name lambda-list
[&rest ([¬ eval] [&rest sexp])]
[&optional (eval def-body)]
&rest (&rest sexp)))
(def-edebug-spec defsubst-maybe-cond
(&define name lambda-list
[&optional stringp]
[&rest ([¬ eval] [&rest sexp])]
[&optional (eval [&optional ("interactive" interactive)] def-body)]
&rest (&rest sexp)))
;; edebug-spec for `static-*' macros are also defined here.
(def-edebug-spec static-if (def-form form body))
(def-edebug-spec static-when (def-form body))
(def-edebug-spec static-unless (def-form body))
(def-edebug-spec static-condition-case
(symbolp def-form &rest ([&or symbolp (&rest symbolp)] body)))
(def-edebug-spec static-defconst (symbolp def-form &optional stringp))
(def-edebug-spec static-cond (&rest (def-form body)))
;;; for backward compatibility.
(defun subr-fboundp (symbol)
"Return t if SYMBOL's function definition is a built-in function."
(and (fboundp symbol)
(subrp (symbol-function symbol))))
;; (make-obsolete 'subr-fboundp "don't use it.")
;;; End.
(require 'product)
(product-provide (provide 'pym) (require 'apel-ver))
;;; pym.el ends here
|
