build: Don't include <config.h> in native programs when cross-compiling.
[bpt/guile.git] / libguile / variable.c
dissimilarity index 89%
index cd4c740..a9cc60e 100644 (file)
-/*     Copyright (C) 1995, 1996, 1997, 1998 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 <stdio.h>
-#include "_scm.h"
-#include "eq.h"
-#include "genio.h"
-#include "smob.h"
-
-#include "scm_validate.h"
-#include "variable.h"
-\f
-
-static int
-prin_var (SCM exp,SCM port,scm_print_state *pstate)
-{
-  scm_puts ("#<variable ", port);
-  scm_intprint(exp, 16, port);
-  {
-    SCM val_cell;
-    val_cell = SCM_CDR(exp);
-    if (SCM_CAR (val_cell) != SCM_UNDEFINED)
-      {
-       scm_puts (" name: ", port);
-       scm_iprin1 (SCM_CAR (val_cell), port, pstate);
-      }
-    scm_puts (" binding: ", port);
-    scm_iprin1 (SCM_CDR (val_cell), port, pstate);
-  }
-  scm_putc('>', port);
-  return 1;
-}
-
-
-static SCM 
-scm_markvar (SCM ptr)
-{
-  return SCM_CDR (ptr);
-}
-
-static SCM
-var_equal (SCM var1, SCM var2)
-{
-  return scm_equal_p (SCM_CDR (var1), SCM_CDR (var2));
-}
-
-int scm_tc16_variable;
-\f
-
-static SCM anonymous_variable_sym;
-
-
-static SCM
-make_vcell_variable (SCM vcell)
-{
-  SCM_RETURN_NEWSMOB (scm_tc16_variable, vcell);
-}
-
-SCM_DEFINE(scm_make_variable, "make-variable", 1, 1, 0, 
-           (SCM init, SCM name_hint),
-"")
-#define FUNC_NAME s_scm_make_variable
-{
-  SCM val_cell;
-  
-  if (name_hint == SCM_UNDEFINED)
-    name_hint = anonymous_variable_sym;
-
-  SCM_NEWCELL(val_cell);
-  SCM_DEFER_INTS;
-  SCM_SETCAR (val_cell, name_hint);
-  SCM_SETCDR (val_cell, init);
-  SCM_ALLOW_INTS;
-  return make_vcell_variable (val_cell);
-}
-#undef FUNC_NAME
-
-
-SCM_DEFINE(scm_make_undefined_variable, "make-undefined-variable", 0, 1, 0, 
-           (SCM name_hint),
-"")
-#define FUNC_NAME s_scm_make_undefined_variable
-{
-  SCM vcell;
-
-  if (name_hint == SCM_UNDEFINED)
-    name_hint = anonymous_variable_sym;
-
-  SCM_NEWCELL (vcell);
-  SCM_DEFER_INTS;
-  SCM_SETCAR (vcell, name_hint);
-  SCM_SETCDR (vcell, SCM_UNDEFINED);
-  SCM_ALLOW_INTS;
-  return make_vcell_variable (vcell);
-}
-#undef FUNC_NAME
-
-
-SCM_DEFINE(scm_variable_p, "variable?", 1, 0, 0, 
-           (SCM obj),
-"")
-#define FUNC_NAME s_scm_variable_p
-{
-  return SCM_BOOL(SCM_VARIABLEP (obj));
-}
-#undef FUNC_NAME
-
-
-SCM_DEFINE(scm_variable_ref, "variable-ref", 1, 0, 0, 
-           (SCM var),
-"")
-#define FUNC_NAME s_scm_variable_ref
-{
-  SCM_VALIDATE_VARIABLE(1,var);
-  return SCM_CDR (SCM_CDR (var));
-}
-#undef FUNC_NAME
-
-
-
-SCM_DEFINE(scm_variable_set_x, "variable-set!", 2, 0, 0,
-           (SCM var, SCM val),
-"")
-#define FUNC_NAME s_scm_variable_set_x
-{
-  SCM_VALIDATE_VARIABLE(1,var);
-  SCM_SETCDR (SCM_CDR (var), val);
-  return SCM_UNSPECIFIED;
-}
-#undef FUNC_NAME
-
-
-SCM_DEFINE(scm_builtin_variable, "builtin-variable", 1, 0, 0, 
-           (SCM name),
-"")
-#define FUNC_NAME s_scm_builtin_variable
-{
-  SCM vcell;
-  SCM var_slot;
-
-  SCM_VALIDATE_SYMBOL(1,name);
-  vcell = scm_sym2vcell (name, SCM_BOOL_F, SCM_BOOL_T);
-  if (vcell == SCM_BOOL_F)
-    return SCM_BOOL_F;
-
-  scm_intern_symbol (scm_symhash_vars, name);
-  var_slot = scm_sym2ovcell (name, scm_symhash_vars);
-
-  SCM_DEFER_INTS;
-  if (   SCM_IMP (SCM_CDR (var_slot))
-      || (SCM_VARVCELL (var_slot) != vcell))
-    SCM_SETCDR (var_slot, make_vcell_variable (vcell));
-  SCM_ALLOW_INTS;
-
-  return SCM_CDR (var_slot);
-}
-#undef FUNC_NAME
-
-
-SCM_DEFINE(scm_variable_bound_p, "variable-bound?", 1, 0, 0, 
-           (SCM var),
-"")
-#define FUNC_NAME s_scm_variable_bound_p
-{
-  SCM_VALIDATE_VARIABLE(1,var);
-  return SCM_NEGATE_BOOL(SCM_UNBNDP (SCM_CDR (SCM_VARVCELL (var))));
-}
-#undef FUNC_NAME
-
-
-
-
-void
-scm_init_variable ()
-{
-  scm_tc16_variable = scm_make_smob_type_mfpe ("variable", 0,
-                                              scm_markvar, NULL, prin_var, var_equal);
-  anonymous_variable_sym = SCM_CAR (scm_sysintern ("anonymous-variable", SCM_UNDEFINED));
-#include "variable.x"
-}
-
+/* Copyright (C) 1995,1996,1997,1998,2000,2001, 2006, 2008, 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/eq.h"
+#include "libguile/ports.h"
+#include "libguile/root.h"
+#include "libguile/smob.h"
+#include "libguile/deprecation.h"
+
+#include "libguile/validate.h"
+#include "libguile/variable.h"
+\f
+
+void
+scm_i_variable_print (SCM exp, SCM port, scm_print_state *pstate)
+{
+  scm_puts ("#<variable ", port);
+  scm_uintprint (SCM_UNPACK (exp), 16, port);
+  scm_puts (" value: ", port);
+  scm_iprin1 (SCM_VARIABLE_REF (exp), port, pstate);
+  scm_putc('>', port);
+}
+
+\f
+
+static SCM
+make_variable (SCM init)
+{
+  return scm_cell (scm_tc7_variable, SCM_UNPACK (init));
+}
+
+SCM_DEFINE (scm_make_variable, "make-variable", 1, 0, 0, 
+            (SCM init),
+            "Return a variable initialized to value @var{init}.")
+#define FUNC_NAME s_scm_make_variable
+{
+  return make_variable (init);
+}
+#undef FUNC_NAME
+
+
+SCM_DEFINE (scm_make_undefined_variable, "make-undefined-variable", 0, 0, 0, 
+            (),
+            "Return a variable that is initially unbound.")
+#define FUNC_NAME s_scm_make_undefined_variable
+{
+  return make_variable (SCM_UNDEFINED);
+}
+#undef FUNC_NAME
+
+
+SCM_DEFINE (scm_variable_p, "variable?", 1, 0, 0, 
+            (SCM obj),
+            "Return @code{#t} iff @var{obj} is a variable object, else\n"
+           "return @code{#f}.")
+#define FUNC_NAME s_scm_variable_p
+{
+  return scm_from_bool (SCM_VARIABLEP (obj));
+}
+#undef FUNC_NAME
+
+
+SCM_DEFINE (scm_variable_ref, "variable-ref", 1, 0, 0, 
+            (SCM var),
+            "Dereference @var{var} and return its value.\n"
+            "@var{var} must be a variable object; see @code{make-variable}\n"
+           "and @code{make-undefined-variable}.")
+#define FUNC_NAME s_scm_variable_ref
+{
+  SCM val;
+  SCM_VALIDATE_VARIABLE (1, var);
+  val = SCM_VARIABLE_REF (var);
+  if (scm_is_eq (val, SCM_UNDEFINED))
+    SCM_MISC_ERROR ("variable is unbound: ~S", scm_list_1 (var));
+  return val;
+}
+#undef FUNC_NAME
+
+SCM_DEFINE (scm_variable_set_x, "variable-set!", 2, 0, 0,
+            (SCM var, SCM val),
+            "Set the value of the variable @var{var} to @var{val}.\n"
+            "@var{var} must be a variable object, @var{val} can be any\n"
+           "value. Return an unspecified value.")
+#define FUNC_NAME s_scm_variable_set_x
+{
+  SCM_VALIDATE_VARIABLE (1, var);
+  SCM_VARIABLE_SET (var, val);
+  return SCM_UNSPECIFIED;
+}
+#undef FUNC_NAME
+
+SCM_DEFINE (scm_variable_unset_x, "variable-unset!", 1, 0, 0,
+            (SCM var),
+            "Ensure that @var{var} is not bound to a value.\n"
+            "@var{var} must be a variable object.")
+#define FUNC_NAME s_scm_variable_unset_x
+{
+  SCM_VALIDATE_VARIABLE (1, var);
+  SCM_VARIABLE_SET (var, SCM_UNDEFINED);
+  return SCM_UNSPECIFIED;
+}
+#undef FUNC_NAME
+
+SCM_DEFINE (scm_variable_bound_p, "variable-bound?", 1, 0, 0, 
+            (SCM var),
+            "Return @code{#t} iff @var{var} is bound to a value.\n"
+            "Throws an error if @var{var} is not a variable object.")
+#define FUNC_NAME s_scm_variable_bound_p
+{
+  SCM_VALIDATE_VARIABLE (1, var);
+  return scm_from_bool (!scm_is_eq (SCM_VARIABLE_REF (var), SCM_UNDEFINED));
+}
+#undef FUNC_NAME
+
+
+void
+scm_init_variable ()
+{
+#include "libguile/variable.x"
+}
+
+/*
+  Local Variables:
+  c-file-style: "gnu"
+  End:
+*/