locking for putc, puts
[bpt/guile.git] / libguile / macros.c
dissimilarity index 86%
index 9cc280c..7423e97 100644 (file)
-/*     Copyright (C) 1995,1996,1997,1998, 2000 Free Software Foundation, Inc.
- * 
- * 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 this software; see the file COPYING.  If not, write to
- * the Free Software Foundation, Inc., 59 Temple Place, Suite 330,
- * Boston, MA 02111-1307 USA
- *
- * As a special exception, the Free Software Foundation gives permission
- * for additional uses of the text contained in its release of GUILE.
- *
- * The exception is that, if you link the GUILE library with other files
- * to produce an executable, this does not by itself cause the
- * resulting executable to be covered by the GNU General Public License.
- * Your use of that executable is in no way restricted on account of
- * linking the GUILE library code into it.
- *
- * This exception does not however invalidate any other reasons why
- * the executable file might be covered by the GNU General Public License.
- *
- * This exception applies only to the code released by the
- * Free Software Foundation under the name GUILE.  If you copy
- * code from other Free Software Foundation releases into a copy of
- * GUILE, as the General Public License permits, the exception does
- * not apply to the code that you add in this way.  To avoid misleading
- * anyone as to the status of such modified files, you must delete
- * this exception notice from them.
- *
- * If you write modifications of your own for GUILE, it is your choice
- * whether to permit this exception to apply to your modifications.
- * If you do not wish that, delete this exception notice.  */
-
-/* Software engineering face-lift by Greg J. Badros, 11-Dec-1999,
-   gjb@cs.washington.edu, http://www.cs.washington.edu/homes/gjb */
-
-\f
-
-#include "libguile/_scm.h"
-#include "libguile/root.h"
-#include "libguile/smob.h"
-
-#include "libguile/validate.h"
-#include "libguile/macros.h"
-
-long scm_tc16_macro;
-
-SCM_DEFINE (scm_makacro, "procedure->syntax", 1, 0, 0,
-            (SCM code),
-           "Returns a @dfn{macro} which, when a symbol defined to this value\n"
-            "appears as the first symbol in an expression, returns the result\n"
-            "of applying @var{code} to the expression and the environment.")
-#define FUNC_NAME s_scm_makacro
-{
-  SCM_VALIDATE_PROC (1,code);
-  SCM_RETURN_NEWSMOB (scm_tc16_macro, SCM_UNPACK (code));
-}
-#undef FUNC_NAME
-
-
-SCM_DEFINE (scm_makmacro, "procedure->macro", 1, 0, 0, 
-           (SCM code),
-           "Returns a @dfn{macro} which, when a symbol defined to this value\n"
-            "appears as the first symbol in an expression, evaluates the result\n"
-            "of applying @var{code} to the expression and the environment.\n"
-            "The value returned from @var{code} which has been passed to\n"
-            "@code{procedure->memoizing-macro} replaces the form passed to\n"
-            "@var{code}.  For example:\n\n"
-            "@example\n"
-            "(define trace\n"
-            "  (procedure->macro\n"
-            "   (lambda (x env) `(set! ,(cadr x) (tracef ,(cadr x) ',(cadr x))))))\n\n"
-            "(trace @i{foo}) @equiv{} (set! @i{foo} (tracef @i{foo} '@i{foo})).\n"
-            "@end example\n")
-#define FUNC_NAME s_scm_makmacro
-{
-  SCM_VALIDATE_PROC (1,code);
-  SCM_RETURN_NEWSMOB (scm_tc16_macro | (1L << 16), SCM_UNPACK (code));
-}
-#undef FUNC_NAME
-
-
-SCM_DEFINE (scm_makmmacro, "procedure->memoizing-macro", 1, 0, 0, 
-           (SCM code),
-           "Returns a @dfn{macro} which, when a symbol defined to this value\n"
-            "appears as the first symbol in an expression, evaluates the result\n"
-            "of applying @var{proc} to the expression and the environment.\n"
-            "The value returned from @var{proc} which has been passed to\n"
-            "@code{procedure->memoizing-macro} replaces the form passed to\n"
-            "@var{proc}.  For example:\n\n"
-            "@example\n"
-            "(define trace\n"
-            "  (procedure->macro\n"
-            "   (lambda (x env) `(set! ,(cadr x) (tracef ,(cadr x) ',(cadr x))))))\n\n"
-            "(trace @i{foo}) @equiv{} (set! @i{foo} (tracef @i{foo} '@i{foo})).\n"
-            "@end example\n")
-#define FUNC_NAME s_scm_makmmacro
-{
-  SCM_VALIDATE_PROC (1,code);
-  SCM_RETURN_NEWSMOB (scm_tc16_macro | (2L << 16), SCM_UNPACK (code));
-}
-#undef FUNC_NAME
-
-
-SCM_DEFINE (scm_macro_p, "macro?", 1, 0, 0, 
-            (SCM obj),
-           "Return @code{#t} if @var{obj} is a regular macro, a memoizing macro or a\n"
-           "syntax transformer.")
-#define FUNC_NAME s_scm_macro_p
-{
-  return SCM_BOOL(SCM_NIMP (obj) && SCM_TYP16 (obj) == scm_tc16_macro);
-}
-#undef FUNC_NAME
-
-
-SCM_SYMBOL (scm_sym_syntax, "syntax");
-SCM_SYMBOL (scm_sym_macro, "macro");
-SCM_SYMBOL (scm_sym_mmacro, "macro!");
-
-SCM_DEFINE (scm_macro_type, "macro-type", 1, 0, 0, 
-            (SCM m),
-           "Return one of the symbols @code{syntax}, @code{macro} or @code{macro!},\n"
-           "depending on whether @var{obj} is a syntax tranformer, a regular macro,\n"
-           "or a memoizing macro, respectively.  If @var{obj} is not a macro,\n"
-           "@code{#f} is returned.")
-#define FUNC_NAME s_scm_macro_type
-{
-  if (!(SCM_NIMP (m) && SCM_TYP16 (m) == scm_tc16_macro))
-    return SCM_BOOL_F;
-  switch (SCM_CELL_WORD_0 (m) >> 16)
-    {
-    case 0: return scm_sym_syntax;
-    case 1: return scm_sym_macro;
-    case 2: return scm_sym_mmacro;
-    default: scm_wrong_type_arg (FUNC_NAME, 1, m);
-    }
-}
-#undef FUNC_NAME
-
-
-SCM_DEFINE (scm_macro_name, "macro-name", 1, 0, 0, 
-            (SCM m),
-           "")
-#define FUNC_NAME s_scm_macro_name
-{
-  SCM_VALIDATE_SMOB (1,m,macro);
-  return scm_procedure_name (SCM_CDR (m));
-}
-#undef FUNC_NAME
-
-
-SCM_DEFINE (scm_macro_transformer, "macro-transformer", 1, 0, 0, 
-            (SCM m),
-           "")
-#define FUNC_NAME s_scm_macro_transformer
-{
-  SCM_VALIDATE_SMOB (1,m,macro);
-  return SCM_CLOSUREP (SCM_CDR (m)) ? SCM_CDR (m) : SCM_BOOL_F;
-}
-#undef FUNC_NAME
-
-SCM
-scm_make_synt (const char *name, SCM (*macroizer) (), SCM (*fcn)() )
-{
-  SCM symcell = scm_sysintern (name, SCM_UNDEFINED);
-  SCM transformer = scm_make_subr_opt (name, scm_tc7_subr_2, fcn, 0);
-  SCM_SETCDR (symcell, macroizer (transformer));
-  return SCM_CAR (symcell);
-}
-
-void
-scm_init_macros ()
-{
-  scm_tc16_macro = scm_make_smob_type_mfpe ("macro", 0,
-                                           scm_markcdr, NULL, NULL, NULL);
-#include "libguile/macros.x"
-}
-
-/*
-  Local Variables:
-  c-file-style: "gnu"
-  End:
-*/
+/* Copyright (C) 1995,1996,1997,1998,2000,2001,2002,2003, 2006, 2008, 2009, 2010, 2011 Free Software Foundation, Inc.
+ * 
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public License
+ * as published by the Free Software Foundation; either version 3 of
+ * the License, or (at your option) any later version.
+ *
+ * This library 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
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
+ * 02110-1301 USA
+ */
+
+
+\f
+#ifdef HAVE_CONFIG_H
+# include <config.h>
+#endif
+
+#include "libguile/_scm.h"
+#include "libguile/ports.h"
+#include "libguile/print.h"
+#include "libguile/smob.h"
+#include "libguile/validate.h"
+#include "libguile/macros.h"
+
+#include "libguile/private-options.h"
+
+
+static scm_t_bits scm_tc16_macro;
+
+#define SCM_MACROP(x) SCM_SMOB_PREDICATE (scm_tc16_macro, (x))
+#define SCM_MACRO_PRIMITIVE(m) ((scm_t_macro_primitive)SCM_SMOB_DATA (m))
+#define SCM_MACRO_NAME(m) (SCM_SMOB_OBJECT_2 (m))
+#define SCM_MACRO_TYPE(m) (SCM_SMOB_OBJECT_3 (m))
+#define SCM_MACRO_BINDING(m) (SCM_CELL_OBJECT ((m), 4))
+#define SCM_VALIDATE_MACRO(p,v) SCM_MAKE_VALIDATE ((p), (v), MACROP)
+
+
+SCM_API scm_t_bits scm_tc16_macro;
+
+
+static int
+macro_print (SCM macro, SCM port, scm_print_state *pstate)
+{
+  if (scm_is_false (SCM_MACRO_TYPE (macro)))
+    scm_puts_unlocked ("#<primitive-syntax-transformer ", port);
+  else
+    scm_puts_unlocked ("#<syntax-transformer ", port);
+  scm_iprin1 (scm_macro_name (macro), port, pstate);
+  scm_putc_unlocked ('>', port);
+
+  return 1;
+}
+
+/* Return a mmacro that is known to be one of guile's built in macros. */
+SCM
+scm_i_make_primitive_macro (const char *name, scm_t_macro_primitive fn)
+{
+  SCM z = scm_words (scm_tc16_macro, 5);
+  SCM_SET_SMOB_DATA_N (z, 1, (scm_t_bits)fn);
+  SCM_SET_SMOB_OBJECT_N (z, 2, scm_from_utf8_symbol (name));
+  SCM_SET_SMOB_OBJECT_N (z, 3, SCM_BOOL_F);
+  SCM_SET_SMOB_OBJECT_N (z, 4, SCM_BOOL_F);
+  return z;
+}
+
+scm_t_macro_primitive
+scm_i_macro_primitive (SCM macro)
+{
+  return SCM_MACRO_PRIMITIVE (macro);
+}
+
+
+SCM_DEFINE (scm_make_syntax_transformer, "make-syntax-transformer", 3, 0, 0,
+            (SCM name, SCM type, SCM binding),
+           "Construct a @dfn{syntax transformer}.\n\n"
+            "This function is part of Guile's low-level support for the psyntax\n"
+            "syntax expander. Users should not call this function.")
+#define FUNC_NAME s_scm_make_syntax_transformer
+{
+  SCM z;
+  SCM (*prim)(SCM,SCM) = NULL;
+
+  if (scm_is_true (name))
+    {
+      SCM existing_var;
+      
+      SCM_VALIDATE_SYMBOL (1, name);
+      existing_var = scm_sym2var (name, scm_current_module_lookup_closure (),
+                                  SCM_BOOL_F);
+      if (scm_is_true (existing_var)
+          && scm_is_true (scm_variable_bound_p (existing_var))
+          && SCM_MACROP (SCM_VARIABLE_REF (existing_var)))
+        prim = SCM_MACRO_PRIMITIVE (SCM_VARIABLE_REF (existing_var));
+    }
+
+  SCM_VALIDATE_SYMBOL (2, type);
+
+  z = scm_words (scm_tc16_macro, 5);
+  SCM_SET_SMOB_DATA_N (z, 1, (scm_t_bits)prim);
+  SCM_SET_SMOB_OBJECT_N (z, 2, name);
+  SCM_SET_SMOB_OBJECT_N (z, 3, type);
+  SCM_SET_SMOB_OBJECT_N (z, 4, binding);
+  return z;
+}
+#undef FUNC_NAME
+
+SCM_DEFINE (scm_macro_p, "macro?", 1, 0, 0, 
+            (SCM obj),
+           "Return @code{#t} if @var{obj} is a syntax transformer (an object that "
+            "transforms Scheme expressions at expansion-time).\n\n"
+            "Macros are actually just one kind of syntax transformer; this\n"
+            "procedure has its name due to historical reasons.")
+#define FUNC_NAME s_scm_macro_p
+{
+  return scm_from_bool (SCM_MACROP (obj));
+}
+#undef FUNC_NAME
+
+SCM_DEFINE (scm_macro_type, "macro-type", 1, 0, 0, 
+            (SCM m),
+           "Return the type of the syntax transformer @var{m}, as passed to\n"
+            "@code{make-syntax-transformer}. If @var{m} is a primitive syntax\n"
+            "transformer, @code{#f} will be returned.")
+#define FUNC_NAME s_scm_macro_type
+{
+  SCM_VALIDATE_MACRO (1, m);
+  return SCM_MACRO_TYPE (m);
+}
+#undef FUNC_NAME
+
+SCM_DEFINE (scm_macro_name, "macro-name", 1, 0, 0, 
+            (SCM m),
+           "Return the name of the syntax transformer @var{m}.")
+#define FUNC_NAME s_scm_macro_name
+{
+  SCM_VALIDATE_MACRO (1, m);
+  return SCM_MACRO_NAME (m);
+}
+#undef FUNC_NAME
+
+SCM_DEFINE (scm_macro_transformer, "macro-transformer", 1, 0, 0, 
+            (SCM m),
+           "Return the transformer procedure of the macro @var{m}.\n\n"
+            "If @var{m} is a syntax transformer but not a macro, @code{#f}\n"
+            "will be returned. (This can happen, for example, with primitive\n"
+            "syntax transformers).")
+#define FUNC_NAME s_scm_macro_transformer
+{
+  SCM_VALIDATE_MACRO (1, m);
+  /* here we rely on knowledge of how psyntax represents macro bindings, but
+     hey, there is code out there that calls this function, and expects to get
+     a procedure in return... */
+  if (scm_is_true (scm_procedure_p (SCM_MACRO_BINDING (m))))
+    return SCM_MACRO_BINDING (m);
+  else
+    return SCM_BOOL_F;
+}
+#undef FUNC_NAME
+
+SCM_DEFINE (scm_macro_binding, "macro-binding", 1, 0, 0, 
+            (SCM m),
+           "Return the binding of the syntax transformer @var{m}, as passed to\n"
+            "@code{make-syntax-transformer}. If @var{m} is a primitive syntax\n"
+            "transformer, @code{#f} will be returned.")
+#define FUNC_NAME s_scm_macro_binding
+{
+  SCM_VALIDATE_MACRO (1, m);
+  return SCM_MACRO_BINDING (m);
+}
+#undef FUNC_NAME
+
+
+void
+scm_init_macros ()
+{
+  scm_tc16_macro = scm_make_smob_type ("macro", 0);
+  scm_set_smob_print (scm_tc16_macro, macro_print);
+#include "libguile/macros.x"
+}
+
+/*
+  Local Variables:
+  c-file-style: "gnu"
+  End:
+*/