1 /* Copyright (C) 1995,1996,1997,1998,2000,2001,2002,2003, 2006, 2008 Free Software Foundation, Inc.
3 * This library is free software; you can redistribute it and/or
4 * modify it under the terms of the GNU Lesser General Public
5 * License as published by the Free Software Foundation; either
6 * version 2.1 of the License, or (at your option) any later version.
8 * This library is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
11 * Lesser General Public License for more details.
13 * You should have received a copy of the GNU Lesser General Public
14 * License along with this library; if not, write to the Free Software
15 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
24 #include "libguile/_scm.h"
25 #include "libguile/alist.h" /* for SCM_EXTEND_ENV (well...) */
26 #include "libguile/eval.h"
27 #include "libguile/ports.h"
28 #include "libguile/print.h"
29 #include "libguile/root.h"
30 #include "libguile/smob.h"
31 #include "libguile/deprecation.h"
33 #include "libguile/validate.h"
34 #include "libguile/macros.h"
36 scm_t_bits scm_tc16_macro;
40 macro_print (SCM macro, SCM port, scm_print_state *pstate)
42 SCM code = SCM_MACRO_CODE (macro);
43 if (!SCM_CLOSUREP (code)
44 || scm_is_false (scm_procedure_p (SCM_PRINT_CLOSURE))
45 || scm_is_false (scm_printer_apply (SCM_PRINT_CLOSURE,
46 macro, port, pstate)))
48 if (!SCM_CLOSUREP (code))
49 scm_puts ("#<primitive-", port);
51 scm_puts ("#<", port);
53 if (SCM_MACRO_TYPE (macro) == 0)
54 scm_puts ("syntax", port);
55 #if SCM_ENABLE_DEPRECATED == 1
56 if (SCM_MACRO_TYPE (macro) == 1)
57 scm_puts ("macro", port);
59 if (SCM_MACRO_TYPE (macro) == 2)
60 scm_puts ("macro!", port);
61 if (SCM_MACRO_TYPE (macro) == 3)
62 scm_puts ("builtin-macro!", port);
65 scm_iprin1 (scm_macro_name (macro), port, pstate);
67 if (SCM_CLOSUREP (code) && SCM_PRINT_SOURCE_P)
69 SCM formals = SCM_CLOSURE_FORMALS (code);
70 SCM env = SCM_ENV (code);
71 SCM xenv = SCM_EXTEND_ENV (formals, SCM_EOL, env);
72 SCM src = scm_i_unmemocopy_body (SCM_CODE (code), xenv);
74 scm_iprin1 (src, port, pstate);
84 makmac (SCM code, scm_t_bits flags)
87 SCM_NEWSMOB (z, scm_tc16_macro, SCM_UNPACK (code));
88 SCM_SET_SMOB_FLAGS (z, flags);
92 /* Return a mmacro that is known to be one of guile's built in macros. */
94 scm_i_makbimacro (SCM code)
95 #define FUNC_NAME "scm_i_makbimacro"
97 SCM_VALIDATE_PROC (1, code);
98 return makmac (code, 3);
103 SCM_DEFINE (scm_makmmacro, "procedure->memoizing-macro", 1, 0, 0,
105 "Return a @dfn{macro} which, when a symbol defined to this value\n"
106 "appears as the first symbol in an expression, evaluates the\n"
107 "result of applying @var{code} to the expression and the\n"
109 "@code{procedure->memoizing-macro} is the same as\n"
110 "@code{procedure->macro}, except that the expression returned by\n"
111 "@var{code} replaces the original macro expression in the memoized\n"
112 "form of the containing code.")
113 #define FUNC_NAME s_scm_makmmacro
115 SCM_VALIDATE_PROC (1, code);
116 return makmac (code, 2);
121 SCM_DEFINE (scm_makacro, "procedure->syntax", 1, 0, 0,
123 "Return a @dfn{macro} which, when a symbol defined to this value\n"
124 "appears as the first symbol in an expression, returns the\n"
125 "result of applying @var{code} to the expression and the\n"
127 #define FUNC_NAME s_scm_makacro
129 SCM_VALIDATE_PROC (1, code);
130 return makmac (code, 0);
135 #if SCM_ENABLE_DEPRECATED == 1
137 SCM_DEFINE (scm_makmacro, "procedure->macro", 1, 0, 0,
139 "Return a @dfn{macro} which, when a symbol defined to this value\n"
140 "appears as the first symbol in an expression, evaluates the\n"
141 "result of applying @var{code} to the expression and the\n"
142 "environment. For example:\n"
146 " (procedure->macro\n"
147 " (lambda (x env) `(set! ,(cadr x) (tracef ,(cadr x) ',(cadr x))))))\n\n"
148 "(trace @i{foo}) @equiv{} (set! @i{foo} (tracef @i{foo} '@i{foo})).\n"
150 #define FUNC_NAME s_scm_makmacro
152 scm_c_issue_deprecation_warning
153 ("The function procedure->macro is deprecated, and so are"
154 " non-memoizing macros in general. Use memoizing macros"
155 " or r5rs macros instead.");
157 SCM_VALIDATE_PROC (1, code);
158 return makmac (code, 1);
165 SCM_DEFINE (scm_macro_p, "macro?", 1, 0, 0,
167 "Return @code{#t} if @var{obj} is a regular macro, a memoizing macro or a\n"
168 "syntax transformer.")
169 #define FUNC_NAME s_scm_macro_p
171 return scm_from_bool (SCM_SMOB_PREDICATE (scm_tc16_macro, obj));
176 SCM_SYMBOL (scm_sym_syntax, "syntax");
177 #if SCM_ENABLE_DEPRECATED == 1
178 SCM_SYMBOL (scm_sym_macro, "macro");
180 SCM_SYMBOL (scm_sym_mmacro, "macro!");
181 SCM_SYMBOL (scm_sym_bimacro, "builtin-macro!");
183 SCM_DEFINE (scm_macro_type, "macro-type", 1, 0, 0,
185 "Return one of the symbols @code{syntax}, @code{macro} or\n"
186 "@code{macro!}, depending on whether @var{m} is a syntax\n"
187 "transformer, a regular macro, or a memoizing macro,\n"
188 "respectively. If @var{m} is not a macro, @code{#f} is\n"
190 #define FUNC_NAME s_scm_macro_type
192 if (!SCM_SMOB_PREDICATE (scm_tc16_macro, m))
194 switch (SCM_MACRO_TYPE (m))
196 case 0: return scm_sym_syntax;
197 #if SCM_ENABLE_DEPRECATED == 1
198 case 1: return scm_sym_macro;
200 case 2: return scm_sym_mmacro;
201 case 3: return scm_sym_bimacro;
202 default: scm_wrong_type_arg (FUNC_NAME, 1, m);
208 SCM_DEFINE (scm_macro_name, "macro-name", 1, 0, 0,
210 "Return the name of the macro @var{m}.")
211 #define FUNC_NAME s_scm_macro_name
213 SCM_VALIDATE_SMOB (1, m, macro);
214 return scm_procedure_name (SCM_PACK (SCM_SMOB_DATA (m)));
219 SCM_DEFINE (scm_macro_transformer, "macro-transformer", 1, 0, 0,
221 "Return the transformer of the macro @var{m}.")
222 #define FUNC_NAME s_scm_macro_transformer
224 SCM_VALIDATE_SMOB (1, m, macro);
225 return ((SCM_CLOSUREP (SCM_PACK (SCM_SMOB_DATA (m)))) ?
226 SCM_PACK(SCM_SMOB_DATA (m)) : SCM_BOOL_F);
231 scm_make_synt (const char *name, SCM (*macroizer) (), SCM (*fcn)() )
233 SCM var = scm_c_define (name, SCM_UNDEFINED);
234 SCM transformer = scm_c_make_subr (name, scm_tc7_subr_2, fcn);
235 SCM_VARIABLE_SET (var, macroizer (transformer));
236 return SCM_UNSPECIFIED;
242 scm_tc16_macro = scm_make_smob_type ("macro", 0);
243 scm_set_smob_mark (scm_tc16_macro, scm_markcdr);
244 scm_set_smob_print (scm_tc16_macro, macro_print);
245 #include "libguile/macros.x"