*** empty log message ***
[bpt/guile.git] / libguile / fluids.h
index 6972e0b..cb4fba4 100644 (file)
@@ -1,48 +1,26 @@
 /* classes: h_files */
 
-#ifndef FLUIDSH
-#define FLUIDSH
-
-/*     Copyright (C) 1996 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.
+#ifndef SCM_FLUIDS_H
+#define SCM_FLUIDS_H
+
+/* Copyright (C) 1996,2000,2001 Free Software Foundation, Inc.
  *
- * This exception does not however invalidate any other reasons why
- * the executable file might be covered by the GNU General Public License.
+ * 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 2.1 of the License, or (at your option) any later version.
  *
- * 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.
+ * 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.
  *
- * 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.  */
+ * 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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+ */
+
+\f
 
 #include "libguile/__scm.h"
 #include "libguile/root.h"
    to index a vector that holds the values of all fluids.  Each root
    has its own vector.
 
-   Currently, you can't get rid a certain fluid if you don't use any
-   longer.  The slot that has been allocated for it in the fluid
+   Currently, you can't get rid a certain fluid if you don't use it
+   any longer.  The slot that has been allocated for it in the fluid
    vector will not be reused for other fluids.  Therefore, only use
-   SCM_MAKE_FLUID or it Scheme variant `make-fluid' in initialization
+   SCM_MAKE_FLUID or its Scheme variant `make-fluid' in initialization
    code that is only run once.  Nevertheless, it should be possible to
    implement a more lightweight version of fluids on top of this basic
    mechanism. */
 
-extern long scm_tc16_fluid;
+SCM_API scm_t_bits scm_tc16_fluid;
 
-#define SCM_FLUIDP(x)    (SCM_CAR(x) == scm_tc16_fluid)
-#define SCM_FLUID_NUM(x) SCM_CDR(x)
+#define SCM_FLUIDP(x)    (!SCM_IMP (x) && (SCM_CELL_TYPE (x) == scm_tc16_fluid))
+#define SCM_FLUID_NUM(x) (SCM_CELL_WORD_1 (x))
 
 /* The fastest way to acces/modify the value of a fluid.  These macros
-does no error checking at all.  You should only use them when you know
+do no error checking at all.  You should only use them when you know
 that the relevant fluid already exists in the current dynamic root.
 The easiest way to ensure this is to execute a SCM_FLUID_SET_X in the
 topmost root, for example right after SCM_MAKE_FLUID in your
@@ -87,13 +65,29 @@ SCM_FLUID_NUM, not the fluid itself. */
 #define SCM_FAST_FLUID_REF(n) (SCM_VELTS(scm_root->fluids)[n])
 #define SCM_FAST_FLUID_SET_X(n, val) (SCM_VELTS(scm_root->fluids)[n] = val)
 
-SCM scm_make_fluid SCM_P ((void));
-SCM scm_fluid_ref SCM_P ((SCM fluid));
-SCM scm_fluid_set_x SCM_P ((SCM fluid, SCM value));
+SCM_API SCM scm_make_fluid (void);
+SCM_API SCM scm_fluid_p (SCM fl);
+SCM_API SCM scm_fluid_ref (SCM fluid);
+SCM_API SCM scm_fluid_set_x (SCM fluid, SCM value);
+
+SCM_API SCM scm_c_with_fluids (SCM fluids, SCM vals,
+                              SCM (*cproc)(void *), void *cdata);
+SCM_API SCM scm_c_with_fluid (SCM fluid, SCM val,
+                             SCM (*cproc)(void *), void *cdata);
+SCM_API SCM scm_with_fluids (SCM fluids, SCM vals, SCM thunk);
+SCM_API SCM scm_with_fluid (SCM fluid, SCM val, SCM thunk);
+
+SCM_API void scm_frame_fluid (SCM fluid, SCM value);
+
+SCM_API SCM scm_i_make_initial_fluids (void);
+SCM_API void scm_i_copy_fluids (scm_root_state *);
 
-SCM scm_make_initial_fluids SCM_P ((void));
-void scm_copy_fluids SCM_P ((scm_root_state *));
+SCM_API void scm_init_fluids (void);
 
-void scm_init_fluids SCM_P ((void));
+#endif  /* SCM_FLUIDS_H */
 
-#endif /* !FLUIDSH */
+/*
+  Local Variables:
+  c-file-style: "gnu"
+  End:
+*/