libguile/macros.c

   1 /*      Copyright (C) 1995,1996,1997,1998 Free Software Foundation, Inc.
   2  *
   3  * This program is free software; you can redistribute it and/or modify
   4  * it under the terms of the GNU General Public License as published by
   5  * the Free Software Foundation; either version 2, or (at your option)
   6  * any later version.
   7  *
   8  * This program 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
  11  * GNU General Public License for more details.
  12  *
  13  * You should have received a copy of the GNU General Public License
  14  * along with this software; see the file COPYING.  If not, write to
  15  * the Free Software Foundation, Inc., 59 Temple Place, Suite 330,
  16  * Boston, MA 02111-1307 USA
  17  *
  18  * As a special exception, the Free Software Foundation gives permission
  19  * for additional uses of the text contained in its release of GUILE.
  20  *
  21  * The exception is that, if you link the GUILE library with other files
  22  * to produce an executable, this does not by itself cause the
  23  * resulting executable to be covered by the GNU General Public License.
  24  * Your use of that executable is in no way restricted on account of
  25  * linking the GUILE library code into it.
  26  *
  27  * This exception does not however invalidate any other reasons why
  28  * the executable file might be covered by the GNU General Public License.
  29  *
  30  * This exception applies only to the code released by the
  31  * Free Software Foundation under the name GUILE.  If you copy
  32  * code from other Free Software Foundation releases into a copy of
  33  * GUILE, as the General Public License permits, the exception does
  34  * not apply to the code that you add in this way.  To avoid misleading
  35  * anyone as to the status of such modified files, you must delete
  36  * this exception notice from them.
  37  *
  38  * If you write modifications of your own for GUILE, it is your choice
  39  * whether to permit this exception to apply to your modifications.
  40  * If you do not wish that, delete this exception notice.  */
  41
  42 /* Software engineering face-lift by Greg J. Badros, 11-Dec-1999,
  43    gjb@cs.washington.edu, http://www.cs.washington.edu/homes/gjb */
  44
  45 \f
  46
  47 #include "_scm.h"
  48 #include "smob.h"
  49
  50 #include "validate.h"
  51 #include "macros.h"
  52
  53 long scm_tc16_macro;
  54
  55 SCM_DEFINE (scm_makacro, "procedure->syntax", 1, 0, 0,
  56             (SCM code),
  57             "Returns a @dfn{macro} which, when a symbol defined to this value\n"
  58             "appears as the first symbol in an expression, returns the result\n"
  59             "of applying @var{code} to the expression and the environment.")
  60 #define FUNC_NAME s_scm_makacro
  61 {
  62   SCM_VALIDATE_PROC (1,code);
  63   SCM_RETURN_NEWSMOB (scm_tc16_macro, code);
  64 }
  65 #undef FUNC_NAME
  66
  67
  68 SCM_DEFINE (scm_makmacro, "procedure->macro", 1, 0, 0,
  69            (SCM code),
  70             "Returns a @dfn{macro} which, when a symbol defined to this value\n"
  71             "appears as the first symbol in an expression, evaluates the result\n"
  72             "of applying @var{code} to the expression and the environment.\n"
  73             "The value returned from @var{code} which has been passed to\n"
  74             "@code{procedure->memoizing-macro} replaces the form passed to\n"
  75             "@var{code}.  For example:\n\n"
  76             "@example\n"
  77             "(define trace\n"
  78             "  (procedure->macro\n"
  79             "   (lambda (x env) `(set! ,(cadr x) (tracef ,(cadr x) ',(cadr x))))))\n\n"
  80             "(trace @i{foo}) @equiv{} (set! @i{foo} (tracef @i{foo} '@i{foo})).\n"
  81             "@end example\n")
  82 #define FUNC_NAME s_scm_makmacro
  83 {
  84   SCM_VALIDATE_PROC (1,code);
  85   SCM_RETURN_NEWSMOB (scm_tc16_macro | (1L << 16), code);
  86 }
  87 #undef FUNC_NAME
  88
  89
  90 SCM_DEFINE (scm_makmmacro, "procedure->memoizing-macro", 1, 0, 0,
  91            (SCM code),
  92             "Returns a @dfn{macro} which, when a symbol defined to this value\n"
  93             "appears as the first symbol in an expression, evaluates the result\n"
  94             "of applying @var{proc} to the expression and the environment.\n"
  95             "The value returned from @var{proc} which has been passed to\n"
  96             "@code{procedure->memoizing-macro} replaces the form passed to\n"
  97             "@var{proc}.  For example:\n\n"
  98             "@example\n"
  99             "(define trace\n"
 100             "  (procedure->macro\n"
 101             "   (lambda (x env) `(set! ,(cadr x) (tracef ,(cadr x) ',(cadr x))))))\n\n"
 102             "(trace @i{foo}) @equiv{} (set! @i{foo} (tracef @i{foo} '@i{foo})).\n"
 103             "@end example\n")
 104 #define FUNC_NAME s_scm_makmmacro
 105 {
 106   SCM_VALIDATE_PROC (1,code);
 107   SCM_RETURN_NEWSMOB (scm_tc16_macro | (2L << 16), code);
 108 }
 109 #undef FUNC_NAME
 110
 111
 112 SCM_DEFINE (scm_macro_p, "macro?", 1, 0, 0,
 113             (SCM obj),
 114             "Return @code{#t} if @var{obj} is a regular macro, a memoizing macro or a\n"
 115             "syntax transformer.")
 116 #define FUNC_NAME s_scm_macro_p
 117 {
 118   return SCM_BOOL(SCM_NIMP (obj) && SCM_TYP16 (obj) == scm_tc16_macro);
 119 }
 120 #undef FUNC_NAME
 121
 122
 123 SCM_SYMBOL (scm_sym_syntax, "syntax");
 124 SCM_SYMBOL (scm_sym_macro, "macro");
 125 SCM_SYMBOL (scm_sym_mmacro, "macro!");
 126
 127 SCM_DEFINE (scm_macro_type, "macro-type", 1, 0, 0,
 128             (SCM m),
 129             "Return one of the symbols @code{syntax}, @code{macro} or @code{macro!},\n"
 130             "depending on whether @var{obj} is a syntax tranformer, a regular macro,\n"
 131             "or a memoizing macro, respectively.  If @var{obj} is not a macro,\n"
 132             "@code{#f} is returned.")
 133 #define FUNC_NAME s_scm_macro_type
 134 {
 135   if (!(SCM_NIMP (m) && SCM_TYP16 (m) == scm_tc16_macro))
 136     return SCM_BOOL_F;
 137   switch ((int) (SCM_CARW (m) >> 16))
 138     {
 139     case 0: return scm_sym_syntax;
 140     case 1: return scm_sym_macro;
 141     case 2: return scm_sym_mmacro;
 142     default: scm_wrong_type_arg (FUNC_NAME, 1, m);
 143     }
 144 }
 145 #undef FUNC_NAME
 146
 147
 148 SCM_DEFINE (scm_macro_name, "macro-name", 1, 0, 0,
 149             (SCM m),
 150             "")
 151 #define FUNC_NAME s_scm_macro_name
 152 {
 153   SCM_VALIDATE_SMOB (1,m,macro);
 154   return scm_procedure_name (SCM_CDR (m));
 155 }
 156 #undef FUNC_NAME
 157
 158
 159 SCM_DEFINE (scm_macro_transformer, "macro-transformer", 1, 0, 0,
 160             (SCM m),
 161             "")
 162 #define FUNC_NAME s_scm_macro_transformer
 163 {
 164   SCM_VALIDATE_SMOB (1,m,macro);
 165   return SCM_CLOSUREP (SCM_CDR (m)) ? SCM_CDR (m) : SCM_BOOL_F;
 166 }
 167 #undef FUNC_NAME
 168
 169 SCM
 170 scm_make_synt (const char *name, SCM (*macroizer) (), SCM (*fcn)() )
 171 {
 172   SCM symcell = scm_sysintern (name, SCM_UNDEFINED);
 173   SCM transformer = scm_make_subr_opt (name, scm_tc7_subr_2, fcn, 0);
 174   SCM_SETCDR (symcell, macroizer (transformer));
 175   return SCM_CAR (symcell);
 176 }
 177
 178 void
 179 scm_init_macros ()
 180 {
 181   scm_tc16_macro = scm_make_smob_type_mfpe ("macro", 0,
 182                                            scm_markcdr, NULL, NULL, NULL);
 183 #include "macros.x"
 184 }