*** empty log message ***
[bpt/guile.git] / libguile / arbiters.c
index d5e374b..d1be6d1 100644 (file)
@@ -1,4 +1,4 @@
-/*     Copyright (C) 1995,1996 Free Software Foundation, Inc.
+/*     Copyright (C) 1995,1996, 1997, 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
@@ -12,7 +12,8 @@
  * 
  * 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, 675 Mass Ave, Cambridge, MA 02139, USA.
+ * 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.
  *
  * 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.  
- */
+ * 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 "smob.h"
+#include "genio.h"
+
+#include "validate.h"
+#include "arbiters.h"
 
 \f
 /* {Arbiters}
 
 static long scm_tc16_arbiter;
 
-#ifdef __STDC__
-static int 
-prinarb (SCM exp, SCM port, int writing)
-#else
+
+#define SCM_ARB_LOCKED(arb) ((SCM_UNPACK_CAR (arb)) & (1L << 16))
+#define SCM_LOCK_ARB(arb) SCM_SETCAR (arb, (SCM) (scm_tc16_arbiter | (1L << 16)));
+#define SCM_UNLOCK_ARB(arb) SCM_SETCAR (arb, (SCM) scm_tc16_arbiter);
+
 static int 
-prinarb (exp, port, writing)
-     SCM exp;
-     SCM port;
-     int writing;
-#endif
+prinarb (SCM exp, SCM port, scm_print_state *pstate)
 {
-  scm_gen_puts (scm_regular_string, "#<arbiter ", port);
-  if (SCM_CAR (exp) & (1L << 16))
-    scm_gen_puts (scm_regular_string, "locked ", port);
-  scm_iprin1 (SCM_CDR (exp), port, writing);
-  scm_gen_putc ('>', port);
+  scm_puts ("#<arbiter ", port);
+  if (SCM_ARB_LOCKED (exp))
+    scm_puts ("locked ", port);
+  scm_iprin1 (SCM_CDR (exp), port, pstate);
+  scm_putc ('>', port);
   return !0;
 }
 
-static scm_smobfuns arbsmob =
-{
-  scm_markcdr, scm_free0, prinarb, 0
-};
-
-SCM_PROC(s_make_arbiter, "make-arbiter", 1, 0, 0, scm_make_arbiter);
-#ifdef __STDC__
-SCM 
-scm_make_arbiter (SCM name)
-#else
-SCM 
-scm_make_arbiter (name)
-     SCM name;
-#endif
+SCM_DEFINE (scm_make_arbiter, "make-arbiter", 1, 0, 0, 
+           (SCM name),
+"Returns an object of type arbiter and name name. Its state is initially unlocked.\n"
+"Arbiters are a way to achieve process synchronization.")
+#define FUNC_NAME s_scm_make_arbiter
 {
-  register SCM z;
-  SCM_NEWCELL (z);
-  SCM_CDR (z) = name;
-  SCM_CAR (z) = scm_tc16_arbiter;
-  return z;
+  SCM_RETURN_NEWSMOB (scm_tc16_arbiter, name);
 }
+#undef FUNC_NAME
 
-SCM_PROC(s_try_arbiter, "try-arbiter", 1, 0, 0, scm_try_arbiter);
-#ifdef __STDC__
-SCM 
-scm_try_arbiter (SCM arb)
-#else
-SCM 
-scm_try_arbiter (arb)
-     SCM arb;
-#endif
+SCM_DEFINE (scm_try_arbiter, "try-arbiter", 1, 0, 0, 
+           (SCM arb),
+"Returns #t and locks arbiter if arbiter was unlocked. Otherwise, returns #f.")
+#define FUNC_NAME s_scm_try_arbiter
 {
-  SCM_ASSERT ((SCM_TYP16 (arb) == scm_tc16_arbiter), arb, SCM_ARG1, s_try_arbiter);
+  SCM_VALIDATE_SMOB (1,arb,arbiter);
   SCM_DEFER_INTS;
-  if (SCM_CAR (arb) & (1L << 16))
+  if (SCM_ARB_LOCKED(arb))
     arb = SCM_BOOL_F;
   else
     {
-      SCM_CAR (arb) = scm_tc16_arbiter | (1L << 16);
+      SCM_LOCK_ARB(arb);
       arb = SCM_BOOL_T;
     }
   SCM_ALLOW_INTS;
   return arb;
 }
+#undef FUNC_NAME
 
 
-SCM_PROC(s_release_arbiter, "release-arbiter", 1, 0, 0, scm_release_arbiter);
-#ifdef __STDC__
-SCM 
-scm_release_arbiter (SCM arb)
-#else
-SCM 
-scm_release_arbiter (arb)
-     SCM arb;
-#endif
+SCM_DEFINE (scm_release_arbiter, "release-arbiter", 1, 0, 0, 
+           (SCM arb),
+"Returns #t and unlocks arbiter if arbiter was locked. Otherwise, returns #f.")
+#define FUNC_NAME s_scm_release_arbiter
 {
-  SCM_ASSERT ((SCM_TYP16 (arb) == scm_tc16_arbiter), arb, SCM_ARG1, s_release_arbiter);
-  if (!(SCM_CAR (arb) & (1L << 16)))
+  SCM_VALIDATE_SMOB (1,arb,arbiter);
+  if (! SCM_ARB_LOCKED(arb))
     return SCM_BOOL_F;
-  SCM_CAR (arb) = scm_tc16_arbiter;
+  SCM_UNLOCK_ARB (arb);
   return SCM_BOOL_T;
 }
+#undef FUNC_NAME
+
 
 
-#ifdef __STDC__
-void
-scm_init_arbiters (void)
-#else
 void
 scm_init_arbiters ()
-#endif
 {
-  scm_tc16_arbiter = scm_newsmob (&arbsmob);
+  scm_tc16_arbiter = scm_make_smob_type_mfpe ("arbiter", 0,
+                                              scm_markcdr, NULL, prinarb, NULL);
 #include "arbiters.x"
 }
-